From 3edff75bca433d4e6b08a08133cd977f97adf4f3 Mon Sep 17 00:00:00 2001 From: Qi Pan <43341456+Pan-Qi@users.noreply.github.com> Date: Thu, 24 Jul 2025 23:57:13 +1000 Subject: [PATCH 1/7] upgrade websites module to autorest v4 --- .../Websites.Autorest/Az.Websites.nuspec | 8 +- .../Properties/AssemblyInfo.cs | 26 + src/Websites/Websites.Autorest/README.md | 73 +-- .../custom/New-AzStaticWebApp.ps1 | 8 +- .../Websites.Autorest/docs/Az.Websites.md | 163 ----- .../docs/Get-AzStaticWebApp.md | 191 ------ .../docs/Get-AzStaticWebAppBuild.md | 187 ------ .../docs/Get-AzStaticWebAppBuildAppSetting.md | 161 ----- .../docs/Get-AzStaticWebAppBuildFunction.md | 130 ---- ...t-AzStaticWebAppBuildFunctionAppSetting.md | 161 ----- .../docs/Get-AzStaticWebAppConfiguredRole.md | 146 ----- .../docs/Get-AzStaticWebAppCustomDomain.md | 187 ------ .../docs/Get-AzStaticWebAppFunction.md | 110 ---- .../Get-AzStaticWebAppFunctionAppSetting.md | 146 ----- .../docs/Get-AzStaticWebAppSecret.md | 146 ----- .../docs/Get-AzStaticWebAppSetting.md | 146 ----- .../docs/Get-AzStaticWebAppUser.md | 161 ----- ...t-AzStaticWebAppUserProvidedFunctionApp.md | 240 -------- .../docs/Get-AzWebAppContinuousWebJob.md | 205 ------- .../docs/Get-AzWebAppSlotContinuousWebJob.md | 221 ------- .../docs/Get-AzWebAppSlotTriggeredWebJob.md | 221 ------- .../Get-AzWebAppSlotTriggeredWebJobHistory.md | 235 ------- .../docs/Get-AzWebAppSlotWebJob.md | 134 ---- .../docs/Get-AzWebAppTriggeredWebJob.md | 205 ------- .../Get-AzWebAppTriggeredWebJobHistory.md | 219 ------- .../docs/Get-AzWebAppWebJob.md | 118 ---- .../docs/New-AzStaticWebApp.md | 576 ------------------ .../docs/New-AzStaticWebAppBuildAppSetting.md | 230 ------- ...w-AzStaticWebAppBuildFunctionAppSetting.md | 230 ------- .../docs/New-AzStaticWebAppCustomDomain.md | 223 ------- .../New-AzStaticWebAppFunctionAppSetting.md | 215 ------- .../docs/New-AzStaticWebAppSetting.md | 215 ------- ...ew-AzStaticWebAppUserRoleInvitationLink.md | 272 --------- ...r-AzStaticWebAppUserProvidedFunctionApp.md | 293 --------- .../docs/Remove-AzStaticWebApp.md | 219 ------- ...Remove-AzStaticWebAppAttachedRepository.md | 211 ------- .../docs/Remove-AzStaticWebAppBuild.md | 235 ------- .../docs/Remove-AzStaticWebAppCustomDomain.md | 235 ------- .../docs/Remove-AzStaticWebAppUser.md | 220 ------- .../docs/Remove-AzWebAppContinuousWebJob.md | 204 ------- .../Remove-AzWebAppSlotContinuousWebJob.md | 221 ------- .../Remove-AzWebAppSlotTriggeredWebJob.md | 221 ------- .../docs/Remove-AzWebAppTriggeredWebJob.md | 204 ------- .../docs/Reset-AzStaticWebAppApiKey.md | 235 ------- .../docs/Start-AzWebAppContinuousWebJob.md | 204 ------- .../Start-AzWebAppSlotContinuousWebJob.md | 221 ------- .../docs/Start-AzWebAppSlotTriggeredWebJob.md | 221 ------- .../docs/Start-AzWebAppTriggeredWebJob.md | 204 ------- .../docs/Stop-AzWebAppContinuousWebJob.md | 204 ------- .../docs/Stop-AzWebAppSlotContinuousWebJob.md | 221 ------- .../docs/Test-AzStaticWebAppCustomDomain.md | 265 -------- ...taticWebAppBuildUserProvidedFunctionApp.md | 220 ------- ...r-AzStaticWebAppUserProvidedFunctionApp.md | 205 ------- .../docs/Update-AzStaticWebApp.md | 484 --------------- .../docs/Update-AzStaticWebAppUser.md | 246 -------- .../Websites.Autorest/examples/README.md | 11 + .../Websites.Autorest/generate-info.json | 3 - .../Websites.Autorest/resources/README.md | 11 + 58 files changed, 58 insertions(+), 11069 deletions(-) create mode 100644 src/Websites/Websites.Autorest/Properties/AssemblyInfo.cs delete mode 100644 src/Websites/Websites.Autorest/docs/Az.Websites.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebApp.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuild.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildAppSetting.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunction.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunctionAppSetting.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppConfiguredRole.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppCustomDomain.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunction.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunctionAppSetting.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSecret.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSetting.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUser.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUserProvidedFunctionApp.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppContinuousWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotContinuousWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJobHistory.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJobHistory.md delete mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebApp.md delete mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md delete mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md delete mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebAppCustomDomain.md delete mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md delete mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md delete mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md delete mode 100644 src/Websites/Websites.Autorest/docs/Register-AzStaticWebAppUserProvidedFunctionApp.md delete mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzStaticWebApp.md delete mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppAttachedRepository.md delete mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppBuild.md delete mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppCustomDomain.md delete mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppUser.md delete mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzWebAppContinuousWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotContinuousWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotTriggeredWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzWebAppTriggeredWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Reset-AzStaticWebAppApiKey.md delete mode 100644 src/Websites/Websites.Autorest/docs/Start-AzWebAppContinuousWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotContinuousWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotTriggeredWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Start-AzWebAppTriggeredWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Stop-AzWebAppContinuousWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Stop-AzWebAppSlotContinuousWebJob.md delete mode 100644 src/Websites/Websites.Autorest/docs/Test-AzStaticWebAppCustomDomain.md delete mode 100644 src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md delete mode 100644 src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppUserProvidedFunctionApp.md delete mode 100644 src/Websites/Websites.Autorest/docs/Update-AzStaticWebApp.md delete mode 100644 src/Websites/Websites.Autorest/docs/Update-AzStaticWebAppUser.md create mode 100644 src/Websites/Websites.Autorest/examples/README.md delete mode 100644 src/Websites/Websites.Autorest/generate-info.json create mode 100644 src/Websites/Websites.Autorest/resources/README.md diff --git a/src/Websites/Websites.Autorest/Az.Websites.nuspec b/src/Websites/Websites.Autorest/Az.Websites.nuspec index 752b43bab4ef..db4f88bb7b83 100644 --- a/src/Websites/Websites.Autorest/Az.Websites.nuspec +++ b/src/Websites/Websites.Autorest/Az.Websites.nuspec @@ -13,7 +13,7 @@ Microsoft Corporation. All rights reserved. Azure ResourceManager ARM PSModule $(service-name) - + @@ -23,9 +23,9 @@ - - - + + + diff --git a/src/Websites/Websites.Autorest/Properties/AssemblyInfo.cs b/src/Websites/Websites.Autorest/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..8a0c6f67269a --- /dev/null +++ b/src/Websites/Websites.Autorest/Properties/AssemblyInfo.cs @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the Apache License, Version 2.0 (the ""License""); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ""AS IS"" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +// is regenerated. + +using System; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")] +[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] +[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] +[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - Websites")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0.0")] +[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0.0")] +[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] +[assembly: System.CLSCompliantAttribute(false)] \ No newline at end of file diff --git a/src/Websites/Websites.Autorest/README.md b/src/Websites/Websites.Autorest/README.md index f1f61384484f..b44f82be5420 100644 --- a/src/Websites/Websites.Autorest/README.md +++ b/src/Websites/Websites.Autorest/README.md @@ -37,13 +37,6 @@ input-file: title: Websites module-version: 0.1.0 subject-prefix: $(service-name) -identity-correction-for-post: true -resourcegroup-append: true -nested-object-to-string: true - -# For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option -use-extension: - "@autorest/powershell": "3.x" directive: #Modify operationId @@ -206,70 +199,8 @@ directive: verb: Unregister subject: BuildUserProvidedFunctionApp -# Remove variant - # Following is two common directive which are normally required in all the RPs - # 1. Remove the unexpanded parameter set - # 2. For New-* cmdlets, ViaIdentity is not required, so CreateViaIdentityExpanded is removed as well - - where: - variant: ^CreateViaIdentityExpanded$|^Create$|^CreateViaIdentity$|^Update$|^UpdateViaIdentity$ - # We got to keep the Create variant of CustomDomain because it's special that it doesn't have a - # CreateExpanded variant, because the only parameters are all in URL rather than request body - subject: CustomDomain - - remove: true - - where: - verb: Test - variant: ^Validate$|^ValidateViaIdentity$ - # We got to keep the Create variant of CustomDomain because it's special that it doesn't have a - # CreateExpanded variant, because the only parameters are all in URL rather than request body - subject: CustomDomain - remove: true - - - where: - variant: ^Create$|^CreateViaIdentity$|^Update$|^UpdateViaIdentity$ - # We got to keep the Create variant of CustomDomain because it's special that it doesn't have a - # CreateExpanded variant, because the only parameters are all in URL rather than request body - subject: BuildAppSetting - remove: true - - - where: - variant: ^Create$|^CreateViaIdentity$|^Update$|^UpdateViaIdentity$ - # We got to keep the Create variant of CustomDomain because it's special that it doesn't have a - # CreateExpanded variant, because the only parameters are all in URL rather than request body - subject: FunctionAppSetting - remove: true - - - where: - variant: ^Create$|^CreateViaIdentity$|^Update$|^UpdateViaIdentity$ - # We got to keep the Create variant of CustomDomain because it's special that it doesn't have a - # CreateExpanded variant, because the only parameters are all in URL rather than request body - subject: Setting - remove: true - - - where: - variant: ^Create$|^CreateViaIdentity$|^Update$|^UpdateViaIdentity$ - # We got to keep the Create variant of CustomDomain because it's special that it doesn't have a - # CreateExpanded variant, because the only parameters are all in URL rather than request body - subject: BuildFunctionAppSetting - remove: true - - - where: - variant: ^Create$|^CreateViaIdentity$|^Update$|^UpdateViaIdentity$ - # We got to keep the Create variant of CustomDomain because it's special that it doesn't have a - # CreateExpanded variant, because the only parameters are all in URL rather than request body - subject: UserRoleInvitationLink - remove: true - - - where: - verb: New - subject: ^$ - variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$ - remove: true - - where: - verb: Update - subject: null - variant: ^Update$|^UpdateViaIdentity$ + variant: ^(Create|Update)(?!.*?(Expanded|JsonFilePath|JsonString)) remove: true - where: @@ -281,7 +212,7 @@ directive: - where: verb: Register subject: UserProvidedFunctionApp - variant: ^Register$|^Register1$|^RegisterViaIdentity$|^RegisterViaIdentity1$|^RegisterViaIdentityExpanded$|^RegisterViaIdentityExpanded1$ + variant: ^Register(?!.*?(JsonFilePath|JsonString)) remove: true # Rename parameters diff --git a/src/Websites/Websites.Autorest/custom/New-AzStaticWebApp.ps1 b/src/Websites/Websites.Autorest/custom/New-AzStaticWebApp.ps1 index da170a4ee184..4408d9189fb2 100644 --- a/src/Websites/Websites.Autorest/custom/New-AzStaticWebApp.ps1 +++ b/src/Websites/Websites.Autorest/custom/New-AzStaticWebApp.ps1 @@ -28,7 +28,7 @@ PS C:\> {{ Add code here }} {{ Add output here }} .Outputs -Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource +Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteArmResource .Notes COMPLEX PARAMETER PROPERTIES @@ -42,7 +42,7 @@ SKUCAPABILITY : Capabilities of the SKU, e.g., is traffic manager https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebapp #> function New-AzStaticWebApp { -[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource])] +[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteArmResource])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(Mandatory)] @@ -135,7 +135,7 @@ param( [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Websites.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IManagedServiceIdentityUserAssignedIdentities]))] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IManagedServiceIdentityUserAssignedIdentities]))] [System.Collections.Hashtable] # The list of user assigned identities associated with the resource. # The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} @@ -187,7 +187,7 @@ param( [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Websites.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IResourceTags]))] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IResourceTags]))] [System.Collections.Hashtable] # Resource tags. ${Tag}, diff --git a/src/Websites/Websites.Autorest/docs/Az.Websites.md b/src/Websites/Websites.Autorest/docs/Az.Websites.md deleted file mode 100644 index 84275c1fda26..000000000000 --- a/src/Websites/Websites.Autorest/docs/Az.Websites.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -Module Name: Az.Websites -Module Guid: e2ccd5b0-af3a-415f-82ed-b9a388aeed61 -Download Help Link: https://learn.microsoft.com/powershell/module/az.websites -Help Version: 1.0.0.0 -Locale: en-US ---- - -# Az.Websites Module -## Description -Microsoft Azure PowerShell: Websites cmdlets - -## Az.Websites Cmdlets -### [Get-AzStaticWebApp](Get-AzStaticWebApp.md) -Description for Gets the details of a static site. - -### [Get-AzStaticWebAppBuild](Get-AzStaticWebAppBuild.md) -Description for Gets the details of a static site build. - -### [Get-AzStaticWebAppBuildAppSetting](Get-AzStaticWebAppBuildAppSetting.md) -Description for Gets the application settings of a static site build. - -### [Get-AzStaticWebAppBuildFunction](Get-AzStaticWebAppBuildFunction.md) -Description for Gets the functions of a particular static site build. - -### [Get-AzStaticWebAppBuildFunctionAppSetting](Get-AzStaticWebAppBuildFunctionAppSetting.md) -Description for Gets the application settings of a static site build. - -### [Get-AzStaticWebAppConfiguredRole](Get-AzStaticWebAppConfiguredRole.md) -Description for Lists the roles configured for the static site. - -### [Get-AzStaticWebAppCustomDomain](Get-AzStaticWebAppCustomDomain.md) -Description for Gets an existing custom domain for a particular static site. - -### [Get-AzStaticWebAppFunction](Get-AzStaticWebAppFunction.md) -Description for Gets the functions of a static site. - -### [Get-AzStaticWebAppFunctionAppSetting](Get-AzStaticWebAppFunctionAppSetting.md) -Description for Gets the application settings of a static site. - -### [Get-AzStaticWebAppSecret](Get-AzStaticWebAppSecret.md) -Description for Lists the secrets for an existing static site. - -### [Get-AzStaticWebAppSetting](Get-AzStaticWebAppSetting.md) -Description for Gets the application settings of a static site. - -### [Get-AzStaticWebAppUser](Get-AzStaticWebAppUser.md) -Description for Gets the list of users of a static site. - -### [Get-AzStaticWebAppUserProvidedFunctionApp](Get-AzStaticWebAppUserProvidedFunctionApp.md) -Description for Gets the details of the user provided function app registered with a static site build - -### [Get-AzWebAppContinuousWebJob](Get-AzWebAppContinuousWebJob.md) -Get or list continuous web for an app. - -### [Get-AzWebAppSlotContinuousWebJob](Get-AzWebAppSlotContinuousWebJob.md) -Get or list continuous web for a deployment slot. - -### [Get-AzWebAppSlotTriggeredWebJob](Get-AzWebAppSlotTriggeredWebJob.md) -Get or list triggered web for a deployment slot. - -### [Get-AzWebAppSlotTriggeredWebJobHistory](Get-AzWebAppSlotTriggeredWebJobHistory.md) -Get or list triggered web job's history for a deployment slot. - -### [Get-AzWebAppSlotWebJob](Get-AzWebAppSlotWebJob.md) -List webjobs for a deployment slot. - -### [Get-AzWebAppTriggeredWebJob](Get-AzWebAppTriggeredWebJob.md) -Get or list triggered web for an app. - -### [Get-AzWebAppTriggeredWebJobHistory](Get-AzWebAppTriggeredWebJobHistory.md) -Get or list triggered web job's history for an app. - -### [Get-AzWebAppWebJob](Get-AzWebAppWebJob.md) -List webjobs for an app. - -### [New-AzStaticWebApp](New-AzStaticWebApp.md) -Description for Creates a new static site in an existing resource group, or updates an existing static site. - -### [New-AzStaticWebAppBuildAppSetting](New-AzStaticWebAppBuildAppSetting.md) -Description for Creates or updates the app settings of a static site build. - -### [New-AzStaticWebAppBuildFunctionAppSetting](New-AzStaticWebAppBuildFunctionAppSetting.md) -Description for Creates or updates the function app settings of a static site build. - -### [New-AzStaticWebAppCustomDomain](New-AzStaticWebAppCustomDomain.md) -Description for Creates a new static site custom domain in an existing resource group and static site. - -### [New-AzStaticWebAppFunctionAppSetting](New-AzStaticWebAppFunctionAppSetting.md) -Description for Creates or updates the function app settings of a static site. - -### [New-AzStaticWebAppSetting](New-AzStaticWebAppSetting.md) -Description for Creates or updates the app settings of a static site. - -### [New-AzStaticWebAppUserRoleInvitationLink](New-AzStaticWebAppUserRoleInvitationLink.md) -Description for Creates an invitation link for a user with the role - -### [Register-AzStaticWebAppUserProvidedFunctionApp](Register-AzStaticWebAppUserProvidedFunctionApp.md) -Description for Register a user provided function app with a static site build - -### [Remove-AzStaticWebApp](Remove-AzStaticWebApp.md) -Description for Deletes a static site. - -### [Remove-AzStaticWebAppAttachedRepository](Remove-AzStaticWebAppAttachedRepository.md) -Description for Detaches a static site. - -### [Remove-AzStaticWebAppBuild](Remove-AzStaticWebAppBuild.md) -Description for Deletes a static site build. - -### [Remove-AzStaticWebAppCustomDomain](Remove-AzStaticWebAppCustomDomain.md) -Description for Deletes a custom domain. - -### [Remove-AzStaticWebAppUser](Remove-AzStaticWebAppUser.md) -Description for Deletes the user entry from the static site. - -### [Remove-AzWebAppContinuousWebJob](Remove-AzWebAppContinuousWebJob.md) -Delete a continuous web job for an app. - -### [Remove-AzWebAppSlotContinuousWebJob](Remove-AzWebAppSlotContinuousWebJob.md) -Delete a continuous web job for a deployment slot. - -### [Remove-AzWebAppSlotTriggeredWebJob](Remove-AzWebAppSlotTriggeredWebJob.md) -Delete a triggered web job for a deployment slot. - -### [Remove-AzWebAppTriggeredWebJob](Remove-AzWebAppTriggeredWebJob.md) -Delete a triggered web job for an app. - -### [Reset-AzStaticWebAppApiKey](Reset-AzStaticWebAppApiKey.md) -Description for Resets the api key for an existing static site. - -### [Start-AzWebAppContinuousWebJob](Start-AzWebAppContinuousWebJob.md) -Start a continuous web job for an app. - -### [Start-AzWebAppSlotContinuousWebJob](Start-AzWebAppSlotContinuousWebJob.md) -Start a continuous web job for a deployment slot. - -### [Start-AzWebAppSlotTriggeredWebJob](Start-AzWebAppSlotTriggeredWebJob.md) -Run a triggered web job for a deployment slot. - -### [Start-AzWebAppTriggeredWebJob](Start-AzWebAppTriggeredWebJob.md) -Run a triggered web job for an app. - -### [Stop-AzWebAppContinuousWebJob](Stop-AzWebAppContinuousWebJob.md) -Stop a continuous web job for an app. - -### [Stop-AzWebAppSlotContinuousWebJob](Stop-AzWebAppSlotContinuousWebJob.md) -Stop a continuous web job for a deployment slot. - -### [Test-AzStaticWebAppCustomDomain](Test-AzStaticWebAppCustomDomain.md) -Description for Validates a particular custom domain can be added to a static site. - -### [Unregister-AzStaticWebAppBuildUserProvidedFunctionApp](Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md) -Description for Detach the user provided function app from the static site build - -### [Unregister-AzStaticWebAppUserProvidedFunctionApp](Unregister-AzStaticWebAppUserProvidedFunctionApp.md) -Description for Detach the user provided function app from the static site - -### [Update-AzStaticWebApp](Update-AzStaticWebApp.md) -Description for Creates a new static site in an existing resource group, or updates an existing static site. - -### [Update-AzStaticWebAppUser](Update-AzStaticWebAppUser.md) -Description for Updates a user entry with the listed roles - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebApp.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebApp.md deleted file mode 100644 index 98a9b1fe0147..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebApp.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebapp -schema: 2.0.0 ---- - -# Get-AzStaticWebApp - -## SYNOPSIS -Description for Gets the details of a static site. - -## SYNTAX - -### List (Default) -``` -Get-AzStaticWebApp [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzStaticWebApp -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzStaticWebApp -InputObject [-DefaultProfile ] [] -``` - -### List1 -``` -Get-AzStaticWebApp -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Description for Gets the details of a static site. - -## EXAMPLES - -### Example 1: List all static web applications under a subscription -```powershell -Get-AzStaticWebApp -``` - -```output -Kind Location Name Type ----- -------- ---- ---- - Central US staticweb-portal04 Microsoft.Web/staticSites - East US 2 staticweb-portal02 Microsoft.Web/staticSites -``` - -This commands list all static web applications under a subscription. - -### Example 2: List all static web applications under a resource group -```powershell -Get-AzStaticWebApp -ResourceGroupName azure-rg-test -``` - -```output -Kind Location Name Type ----- -------- ---- ---- - Central US staticweb-portal04 Microsoft.Web/staticSites - East US 2 staticweb-portal02 Microsoft.Web/staticSites -``` - -This commands list all static web applications under a resource group. - -### Example 3: Get a static web application by name -```powershell -Get-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb-portal04 -``` - -```output -Kind Location Name Type ----- -------- ---- ---- - Central US staticweb-portal04 Microsoft.Web/staticSites -``` - -This commands gets a static web application by name. - -### Example 4: Get a static web application by pipeline -```powershell -New-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb-pwsh01 -Location eastus2 -RepositoryUrl 'https://github.com/username/RepoName' -RepositoryToken 'repoToken123' -Branch 'master' -AppLocation 'Client' -ApiLocation 'Api' -OutputLocation 'wwwroot' -SkuName 'free' | Get-AzStaticWebApp -``` - -```output -Kind Location Name Type ----- -------- ---- ---- - Central US staticweb-portal04 Microsoft.Web/staticSites -``` - -This commands gets a static web application by pipeline. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Get, List1 -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: Get, List, List1 -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuild.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuild.md deleted file mode 100644 index ab43028ab87d..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuild.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappbuild -schema: 2.0.0 ---- - -# Get-AzStaticWebAppBuild - -## SYNOPSIS -Description for Gets the details of a static site build. - -## SYNTAX - -### List (Default) -``` -Get-AzStaticWebAppBuild -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzStaticWebAppBuild -EnvironmentName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzStaticWebAppBuild -InputObject [-DefaultProfile ] [] -``` - -## DESCRIPTION -Description for Gets the details of a static site build. - -## EXAMPLES - -### Example 1: List all builds under a static web app -```powershell -Get-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal04 -``` - -```output -Kind Name Type ----- ---- ---- - default Microsoft.Web/staticSites/builds -``` - -This command list all builds under a static web app. -Automatically create a new build in static web app When creating a new pull request for branch. - -### Example 2: Get the details of a static site build -```powershell -Get-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal04 -EnvironmentName 'default' -``` - -```output -Kind Name Type ----- ---- ---- - default Microsoft.Web/staticSites/builds -``` - -This command gets the details of a static site build. - -### Example 3: Get the details of a static site build pipeline -```powershell -Get-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal04 | Get-AzStaticWebAppBuild -``` - -```output -Kind Name Type ----- ---- ---- - default Microsoft.Web/staticSites/builds -``` - -This command gets the details of a static site build by pipeline. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -The stage site identifier. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteBuildArmResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildAppSetting.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildAppSetting.md deleted file mode 100644 index 47b0ffb8b3b1..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildAppSetting.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappbuildappsetting -schema: 2.0.0 ---- - -# Get-AzStaticWebAppBuildAppSetting - -## SYNOPSIS -Description for Gets the application settings of a static site build. - -## SYNTAX - -``` -Get-AzStaticWebAppBuildAppSetting -EnvironmentName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Gets the application settings of a static site build. - -## EXAMPLES - -### Example 1: Get the application settings of a static web build -```powershell -Get-AzStaticWebAppBuildAppSetting -ResourceGroupName azure-rg-test -Name staticweb-portal04 -EnvironmentName 'default' -``` - -```output -Kind Name Type ----- ---- ---- - appsettings Microsoft.Web/staticSites/builds/config -``` - -This command gets the application settings of a static web build. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -The stage site identifier. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunction.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunction.md deleted file mode 100644 index 1b8af5c0a2d5..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunction.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappbuildfunction -schema: 2.0.0 ---- - -# Get-AzStaticWebAppBuildFunction - -## SYNOPSIS -Description for Gets the functions of a particular static site build. - -## SYNTAX - -``` -Get-AzStaticWebAppBuildFunction -EnvironmentName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Description for Gets the functions of a particular static site build. - -## EXAMPLES - -### Example 1: List all functions of a particular static site build -```powershell -Get-AzStaticWebAppBuildFunction -ResourceGroupName lucas-rg-test -Name staticweb-portal04 -EnvironmentName 'default' -``` - -```output -Kind Name Type ----- ---- ---- - WeatherForecast Microsoft.Web/staticSites/builds/functions -``` - -This command lists all functions of a particular static site build. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -The stage site identifier. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteFunctionOverviewArmResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunctionAppSetting.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunctionAppSetting.md deleted file mode 100644 index c17031a23d56..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunctionAppSetting.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappbuildfunctionappsetting -schema: 2.0.0 ---- - -# Get-AzStaticWebAppBuildFunctionAppSetting - -## SYNOPSIS -Description for Gets the application settings of a static site build. - -## SYNTAX - -``` -Get-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Gets the application settings of a static site build. - -## EXAMPLES - -### Example 1: List all application settings of a static site build -```powershell -Get-AzStaticWebAppBuildFunctionAppSetting -ResourceGroupName azure-rg-test -Name staticweb-portal04 -EnvironmentName 'default' -``` - -```output -Kind Name Type ----- ---- ---- - appsettings Microsoft.Web/staticSites/builds/config/functionappsettings -``` - -This command lists all application settings of a static site build. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -The stage site identifier. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppConfiguredRole.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppConfiguredRole.md deleted file mode 100644 index 34a1f6d709e2..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppConfiguredRole.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappconfiguredrole -schema: 2.0.0 ---- - -# Get-AzStaticWebAppConfiguredRole - -## SYNOPSIS -Description for Lists the roles configured for the static site. - -## SYNTAX - -``` -Get-AzStaticWebAppConfiguredRole -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Lists the roles configured for the static site. - -## EXAMPLES - -### Example 1: Lists the roles configured for the static site -```powershell -Get-AzStaticWebAppConfiguredRole -ResourceGroupName azure-rg-test -Name staticweb-portal04 -``` - -```output -Kind Name Type Property ----- ---- ---- -------- - configuredRoles Microsoft.Web/staticSites/configuredRoles {anonymous, authenticated} -``` - -This command lists the roles configured for the static site. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringList - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppCustomDomain.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppCustomDomain.md deleted file mode 100644 index d7d3922ce870..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppCustomDomain.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappcustomdomain -schema: 2.0.0 ---- - -# Get-AzStaticWebAppCustomDomain - -## SYNOPSIS -Description for Gets an existing custom domain for a particular static site. - -## SYNTAX - -### List (Default) -``` -Get-AzStaticWebAppCustomDomain -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzStaticWebAppCustomDomain -InputObject [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Description for Gets an existing custom domain for a particular static site. - -## EXAMPLES - -### Example 1: List all existing custom domains for a particular static site -```powershell -Get-AzStaticWebAppCustomDomain -ResourceGroupName azure-rg-test -Name staticweb00 -``` - -```output -Kind Name Type ----- ---- ---- - www01.azpstest.net Microsoft.Web/staticSites/customDomains -``` - -This command lists all existing custom domains for a particular static site. - -### Example 2: Get an existing custom domain for a particular static site -```powershell -Get-AzStaticWebAppCustomDomain -ResourceGroupName azure-rg-test -Name staticweb00 -DomainName 'www02.azpstest.net' -``` - -```output -Kind Name Type ----- ---- ---- - www02.azpstest.net Microsoft.Web/staticSites/customDomains -``` - -This command gets an existing custom domain for a particular static site. - -### Example 3: Get an existing custom domain for a particular static site by pipeline -```powershell -New-AzStaticWebAppCustomDomain -ResourceGroupName azure-rg-test -Name staticweb00 -DomainName 'www02.azpstest.net' | Get-AzStaticWebAppCustomDomain -``` - -```output -Kind Name Type ----- ---- ---- - www02.azpstest.net Microsoft.Web/staticSites/customDomains -``` - -This command gets an existing custom domain for a particular static site by pipeline. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -The custom domain name. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the static site resource to search in. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteCustomDomainOverviewArmResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunction.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunction.md deleted file mode 100644 index a0a604610d5a..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunction.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappfunction -schema: 2.0.0 ---- - -# Get-AzStaticWebAppFunction - -## SYNOPSIS -Description for Gets the functions of a static site. - -## SYNTAX - -``` -Get-AzStaticWebAppFunction -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Description for Gets the functions of a static site. - -## EXAMPLES - -### Example 1: Get the functions of a static site -```powershell -Get-AzStaticWebAppFunction -ResourceGroupName azure-rg-test -Name staticweb-portal04 - -``` - -This command get the functions of a static site. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteFunctionOverviewArmResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunctionAppSetting.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunctionAppSetting.md deleted file mode 100644 index f8c51977836f..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunctionAppSetting.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappfunctionappsetting -schema: 2.0.0 ---- - -# Get-AzStaticWebAppFunctionAppSetting - -## SYNOPSIS -Description for Gets the application settings of a static site. - -## SYNTAX - -``` -Get-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Gets the application settings of a static site. - -## EXAMPLES - -### Example 1: Get the application settings of a static site -```powershell -Get-AzStaticWebAppFunctionAppSetting -ResourceGroupName azure-rg-test -Name staticweb-portal04 -``` - -```output -Kind Name Type ----- ---- ---- - appsettings Microsoft.Web/staticSites/config/functionappsettings -``` - -This command gets the application settings of a static site. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSecret.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSecret.md deleted file mode 100644 index 1c3910e542bb..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSecret.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappsecret -schema: 2.0.0 ---- - -# Get-AzStaticWebAppSecret - -## SYNOPSIS -Description for Lists the secrets for an existing static site. - -## SYNTAX - -``` -Get-AzStaticWebAppSecret -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Lists the secrets for an existing static site. - -## EXAMPLES - -### Example 1: List the secrets for an existing static site -```powershell -Get-AzStaticWebAppSecret -ResourceGroupName resourceGroup -Name staticweb-portal04 -``` - -```output -Kind Name Type ----- ---- ---- - secrets Microsoft.Web/staticSites/secrets -``` - -This command lists the secrets for an existing static site. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSetting.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSetting.md deleted file mode 100644 index 68bd3f9c810a..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSetting.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappsetting -schema: 2.0.0 ---- - -# Get-AzStaticWebAppSetting - -## SYNOPSIS -Description for Gets the application settings of a static site. - -## SYNTAX - -``` -Get-AzStaticWebAppSetting -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Gets the application settings of a static site. - -## EXAMPLES - -### Example 1: Get the application settings of a static site -```powershell -Get-AzStaticWebAppSetting -ResourceGroupName resourceGroup -Name staticweb00 -``` - -```output -Kind Name Type ----- ---- ---- - appsettings Microsoft.Web/staticSites/config -``` - -This command gets the application settings of a static site. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUser.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUser.md deleted file mode 100644 index b3fe21760ebc..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUser.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappuser -schema: 2.0.0 ---- - -# Get-AzStaticWebAppUser - -## SYNOPSIS -Description for Gets the list of users of a static site. - -## SYNTAX - -``` -Get-AzStaticWebAppUser -AuthProvider -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Gets the list of users of a static site. - -## EXAMPLES - -### Example 1: Get the list of users of a static site -```powershell -Get-AzStaticWebAppUser -ResourceGroupName azure-rg-test -Name staticweb-portal04 -Authprovider all -``` - -```output -Kind Name Type ----- ---- ---- - c387198f0a7f44748184c9da92cbe241 Microsoft.Web/staticSites/users -``` - -This command gets the list of users of a static site. - -## PARAMETERS - -### -AuthProvider -The auth provider for the users. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserArmResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUserProvidedFunctionApp.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUserProvidedFunctionApp.md deleted file mode 100644 index 0d81a5cbc38b..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUserProvidedFunctionApp.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappuserprovidedfunctionapp -schema: 2.0.0 ---- - -# Get-AzStaticWebAppUserProvidedFunctionApp - -## SYNOPSIS -Description for Gets the details of the user provided function app registered with a static site build - -## SYNTAX - -### List1 (Default) -``` -Get-AzStaticWebAppUserProvidedFunctionApp -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -FunctionAppName -Name - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzStaticWebAppUserProvidedFunctionApp -InputObject [-DefaultProfile ] - [] -``` - -### List -``` -Get-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### List2 -``` -Get-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Description for Gets the details of the user provided function app registered with a static site build - -## EXAMPLES - -### Example 1: List the details of the user provided function apps registered with a static site -```powershell -Get-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName resourceGroup -Name staticweb00 -``` - -```output -Kind Name Type ----- ---- ---- - functionApp-5enjko Microsoft.Web/staticSites/userProvidedFunctionApps -``` - -This command lists the details of the user provided function apps registered with a static site - -### Example 2: List the details of the user provided function apps registered with a static site build -```powershell -Get-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName resourceGroup -Name staticweb00 -EnvironmentName 'default' -``` - -```output -Kind Name Type ----- ---- ---- - functionApp-5enjko Microsoft.Web/staticSites/builds/userProvidedFunctionApps -``` - -This command lists the details of the user provided function apps registered with a static site build. - -### Example 3: List the details of the user provided function apps registered -```powershell -Get-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName resourceGroup -Name staticweb00 -FunctionAppName $env.functionAppName01 -``` - -```output -Kind Name Type ----- ---- ---- - functionApp-5enjko Microsoft.Web/staticSites/builds/userProvidedFunctionApps -``` - -This command lists the details of the user provided function apps registered. - -### Example 4: Get the details of the user provided function app registered with a static site build -```powershell -Get-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName resourceGroup -Name staticweb00 -EnvironmentName 'default' -FunctionAppName $env.functionAppName01 -``` - -```output -Kind Name Type ----- ---- ---- - functionApp-5enjko Microsoft.Web/staticSites/builds/userProvidedFunctionApps -``` - -This command gets the details of the user provided function app registered with a static site build. - -### Example 5: Get the details of the user provided function apps registered with a static site build by pipeline -```powershell -Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName lucas-rg-test -Name staticweb-pwsh02 -FunctionAppName functionapp-portal02 -FunctionAppResourceId '/subscriptions/xxxxxx-xx-xxx-xxxx-xxxxx/resourcegroups/xxx-xx-xxxx/providers/Microsoft.Web/sites/functionapp-portal02' -FunctionAppRegion 'Central US' -EnvironmentName 5 | Get-AzStaticWebAppUserProvidedFunctionApp -``` - -```output -Kind Name Type ----- ---- ---- - functionApp-5enjko Microsoft.Web/staticSites/builds/userProvidedFunctionApps -``` - -This command gets the details of the user provided function app registered with a static site build by pipeline. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -The stage site identifier. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FunctionAppName -Name of the function app registered with the static site build. - -```yaml -Type: System.String -Parameter Sets: Get, List2 -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: Get, List, List1, List2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Get, List, List1, List2 -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: Get, List, List1, List2 -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserProvidedFunctionAppArmResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppContinuousWebJob.md deleted file mode 100644 index d563d0d94456..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzWebAppContinuousWebJob.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappcontinuouswebjob -schema: 2.0.0 ---- - -# Get-AzWebAppContinuousWebJob - -## SYNOPSIS -Get or list continuous web for an app. - -## SYNTAX - -### List (Default) -``` -Get-AzWebAppContinuousWebJob -AppName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzWebAppContinuousWebJob -AppName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [] -``` - -### GetViaIdentity -``` -Get-AzWebAppContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] - [] -``` - -## DESCRIPTION -Get or list continuous web for an app. - -## EXAMPLES - -### Example 1: List continuous webs for an app -```powershell -Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -``` - -```output -Name Kind WebJobType ResourceGroupName ----- ---- ---------- ----------------- -appService-test01/continuousjob-01 webjob-rg-test -appService-test01/continuousjob-02 webjob-rg-test -``` - -This command lists continuous webs for an app. - -### Example 2: Get continuous web for an app -```powershell -Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 -``` - -```output -Name Kind WebJobType ResourceGroupName ----- ---- ---------- ----------------- -appService-test01/continuousjob-01 webjob-rg-test -``` - -This command gets continuous web for an app. - -### Example 3: Get continuous web for an app by pipeline -```powershell -$webjob = Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 -Start-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 -$webjob.Id | Get-AzWebAppContinuousWebJob -``` - -```output -Name Kind WebJobType ResourceGroupName ----- ---- ---------- ----------------- -appService-test01/continuousjob-01 webjob-rg-test -``` - -This command gets continuous web for an app by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Get, GetViaIdentity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IContinuousWebJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotContinuousWebJob.md deleted file mode 100644 index bac8b01748e2..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotContinuousWebJob.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslotcontinuouswebjob -schema: 2.0.0 ---- - -# Get-AzWebAppSlotContinuousWebJob - -## SYNOPSIS -Get or list continuous web for a deployment slot. - -## SYNTAX - -### List (Default) -``` -Get-AzWebAppSlotContinuousWebJob -AppName -ResourceGroupName -SlotName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzWebAppSlotContinuousWebJob -AppName -Name -ResourceGroupName - -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [] -``` - -### GetViaIdentity -``` -Get-AzWebAppSlotContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] - [] -``` - -## DESCRIPTION -Get or list continuous web for a deployment slot. - -## EXAMPLES - -### Example 1: List continuous webs for a deployment slot -```powershell -Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -``` - -```output -Name Kind WebJobType ResourceGroupName ----- ---- ---------- ----------------- -appService-test01/slot01/slotcontinuousjob-03 webjob-rg-test -appService-test01/slot01/slotcontinuousjob-04 webjob-rg-test -``` - -This command lists continuous webs for a deployment slot. - -### Example 2: Get continuous web for a deployment slot -```powershell -Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-03 -``` - -```output -Name Kind WebJobType ResourceGroupName ----- ---- ---------- ----------------- -appService-test01/slot01/slotcontinuousjob-03 webjob-rg-test -``` - -This command gets continuous web for a deployment slot. - -### Example 3: Get continuous web for a deployment slot by pipeline -```powershell -$webjob = Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-03 -Start-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-03 -$webjob.Id | Get-AzWebAppSlotContinuousWebJob -``` - -```output -Name Kind WebJobType ResourceGroupName ----- ---- ---------- ----------------- -appService-test01/slot01/slotcontinuousjob-03 webjob-rg-test -``` - -This command gets continuous web for a deployment slot by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Get, GetViaIdentity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlotName -Name of the deployment slot. -If a slot is not specified, the API deletes a deployment for the production slot. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IContinuousWebJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJob.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJob.md deleted file mode 100644 index e1ed639fc601..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJob.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslottriggeredwebjob -schema: 2.0.0 ---- - -# Get-AzWebAppSlotTriggeredWebJob - -## SYNOPSIS -Get or list triggered web for a deployment slot. - -## SYNTAX - -### List (Default) -``` -Get-AzWebAppSlotTriggeredWebJob -AppName -ResourceGroupName -SlotName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzWebAppSlotTriggeredWebJob -AppName -Name -ResourceGroupName - -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [] -``` - -### GetViaIdentity -``` -Get-AzWebAppSlotTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] - [] -``` - -## DESCRIPTION -Get or list triggered web for a deployment slot. - -## EXAMPLES - -### Example 1: List triggered webs for a deployment slot -```powershell -Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -``` - -```output -Name Kind WebJobType ResourceGroupName ----- ---- ---------- ----------------- -appService-test01/slot01/slottriggeredjob-03 webjob-rg-test -appService-test01/slot01/slottriggeredjob-04 webjob-rg-test -``` - -This command lists triggered webs for a deployment slot. - -### Example 2: Get triggered web for a deployment slot -```powershell -Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 -``` - -```output -Name Kind WebJobType ResourceGroupName ----- ---- ---------- ----------------- -appService-test01/slot01/slottriggeredjob-03 webjob-rg-test -``` - -This command gets triggered web for a deployment slot. - -### Example 3: Get triggered web for a deployment slot by pipeline -```powershell -$webjob = Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 -Start-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 -$webjob.Id | Get-AzWebAppSlotTriggeredWebJob -``` - -```output -Name Kind WebJobType ResourceGroupName ----- ---- ---------- ----------------- -appService-test01/slot01/slottriggeredjob-03 webjob-rg-test -``` - -This command gets triggered web for a deployment slot by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Get, GetViaIdentity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlotName -Name of the deployment slot. -If a slot is not specified, the API uses the production slot. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredWebJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJobHistory.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJobHistory.md deleted file mode 100644 index 6b6a27e8ae6a..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJobHistory.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslottriggeredwebjobhistory -schema: 2.0.0 ---- - -# Get-AzWebAppSlotTriggeredWebJobHistory - -## SYNOPSIS -Get or list triggered web job's history for a deployment slot. - -## SYNTAX - -### List (Default) -``` -Get-AzWebAppSlotTriggeredWebJobHistory -AppName -Name -ResourceGroupName - -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [] -``` - -### Get -``` -Get-AzWebAppSlotTriggeredWebJobHistory -AppName -Id -Name - -ResourceGroupName -SlotName [-SubscriptionId ] [-DefaultProfile ] - [-PassThru] [] -``` - -### GetViaIdentity -``` -Get-AzWebAppSlotTriggeredWebJobHistory -InputObject [-DefaultProfile ] - [-PassThru] [] -``` - -## DESCRIPTION -Get or list triggered web job's history for a deployment slot. - -## EXAMPLES - -### Example 1: List triggered web job's history for a deployment slot -```powershell -Get-AzWebAppSlotTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 -``` - -```output -Kind Name ResourceGroupName ----- ---- ----------------- - appService-test01/slot01/slottriggeredjob-03/202201040202032401 webjob-rg-test -``` - -This command list triggered web job's history for a deployment slot. - -### Example 2: Get triggered web job's history for a deployment slot -```powershell -Get-AzWebAppSlotTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 -Id 202201040202032401 -``` - -```output -Kind Name ResourceGroupName ----- ---- ----------------- - appService-test01/slot01/slottriggeredjob-03/202201040202032401 webjob-rg-test -``` - -This command get triggered web job's history for a deployment slot. - -### Example 3: Get triggered web job's history for a deployment slot by pipeline -```powershell -$jobs = Get-AzWebAppSlotTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 -$jobs[0].Id | Get-AzWebAppSlotTriggeredWebJobHistory -``` - -```output -Kind Name ResourceGroupName ----- ---- ----------------- - appService-test01/slot01/slottriggeredjob-03/202201040202032401 webjob-rg-test -``` - -This command get triggered web job's history for a deployment slot by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -History ID. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlotName -Name of the deployment slot. -If a slot is not specified, the API uses the production slot. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredJobHistory - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotWebJob.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotWebJob.md deleted file mode 100644 index 905bee3fc2ee..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotWebJob.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslotwebjob -schema: 2.0.0 ---- - -# Get-AzWebAppSlotWebJob - -## SYNOPSIS -List webjobs for a deployment slot. - -## SYNTAX - -``` -Get-AzWebAppSlotWebJob -AppName -ResourceGroupName -SlotName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -List webjobs for a deployment slot. - -## EXAMPLES - -### Example 1: List webjobs for a deployment slot -```powershell -Get-AzWebAppSlotWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -``` - -```output -Name Kind WebJobType ResourceGroupName ----- ---- ---------- ----------------- -appService-test01/slot01/slottriggeredjob-03 webjob-rg-test -appService-test01/slot01/slottriggeredjob-04 webjob-rg-test -appService-test01/slot01/slotcontinuousjob-03 webjob-rg-test -appService-test01/slot01/slotcontinuousjob-04 webjob-rg-test -``` - -This command lists webjobs for a deployment slot. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlotName -Name of the deployment slot. -If a slot is not specified, the API returns deployments for the production slot. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IWebJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJob.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJob.md deleted file mode 100644 index 40a6798629fb..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJob.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebapptriggeredwebjob -schema: 2.0.0 ---- - -# Get-AzWebAppTriggeredWebJob - -## SYNOPSIS -Get or list triggered web for an app. - -## SYNTAX - -### List (Default) -``` -Get-AzWebAppTriggeredWebJob -AppName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzWebAppTriggeredWebJob -AppName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [] -``` - -### GetViaIdentity -``` -Get-AzWebAppTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] - [] -``` - -## DESCRIPTION -Get or list triggered web for an app. - -## EXAMPLES - -### Example 1: List triggered webs for an app -```powershell -Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -``` - -```output -Name Kind WebJobType ResourceGroupName ----- ---- ---------- ----------------- -appService-test01/triggeredjob-01 webjob-rg-test -appService-test01/triggeredjob-02 webjob-rg-test -``` - -This command lists triggered webs for an app. - -### Example 2: Get triggered web for an app -```powershell -Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 -``` - -```output -Name Kind WebJobType ResourceGroupName ----- ---- ---------- ----------------- -appService-test01/triggeredjob-01 webjob-rg-test -``` - -This command gets triggered web for an app. - -### Example 3: Get triggered web for an app by pipeline -```powershell -$webjob = Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 -Start-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 -$webjob.Id | Get-AzWebAppTriggeredWebJob -``` - -```output -Name Kind WebJobType ResourceGroupName ----- ---- ---------- ----------------- -appService-test01/triggeredjob-01 webjob-rg-test -``` - -This command gets triggered web for an app by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Get, GetViaIdentity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredWebJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJobHistory.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJobHistory.md deleted file mode 100644 index 8941c42d13cb..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJobHistory.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebapptriggeredwebjobhistory -schema: 2.0.0 ---- - -# Get-AzWebAppTriggeredWebJobHistory - -## SYNOPSIS -Get or list triggered web job's history for an app. - -## SYNTAX - -### List (Default) -``` -Get-AzWebAppTriggeredWebJobHistory -AppName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [] -``` - -### Get -``` -Get-AzWebAppTriggeredWebJobHistory -AppName -Id -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [] -``` - -### GetViaIdentity -``` -Get-AzWebAppTriggeredWebJobHistory -InputObject [-DefaultProfile ] [-PassThru] - [] -``` - -## DESCRIPTION -Get or list triggered web job's history for an app. - -## EXAMPLES - -### Example 1: List triggered web job's history for an app -```powershell -Get-AzWebAppTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 -``` - -```output -Kind Name ResourceGroupName ----- ---- ----------------- - appService-test01/triggeredjob-01/202201040249386155 webjob-rg-test - appService-test01/triggeredjob-01/202201040236300466 webjob-rg-test -``` - -This command lists triggered web job's history for an app. - -### Example 2: Get triggered web job's history for an app -```powershell -Get-AzWebAppTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 -Id 202201040236300466 -``` - -```output -Kind Name ResourceGroupName ----- ---- ----------------- - appService-test01/triggeredjob-01/202201040236300466 webjob-rg-test -``` - -This command get triggered web job's history for an app. - -### Example 3: Get triggered web job's history for an app by pipeline -```powershell -$logs = Get-AzWebAppTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 -$logs[0].Id | Get-AzWebAppTriggeredWebJobHistory -``` - -```output -Kind Name ResourceGroupName ----- ---- ----------------- - appService-test01/triggeredjob-01/202201040236300466 webjob-rg-test -``` - -This command get triggered web job's history for an app by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -History ID. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredJobHistory - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppWebJob.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppWebJob.md deleted file mode 100644 index 023232e94ef8..000000000000 --- a/src/Websites/Websites.Autorest/docs/Get-AzWebAppWebJob.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappwebjob -schema: 2.0.0 ---- - -# Get-AzWebAppWebJob - -## SYNOPSIS -List webjobs for an app. - -## SYNTAX - -``` -Get-AzWebAppWebJob -AppName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -List webjobs for an app. - -## EXAMPLES - -### Example 1: List webjobs for an app -```powershell -Get-AzWebAppWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -``` - -```output -Name Kind WebJobType ----- ---- ---------- -appService-test01/triggeredjob-01 -appService-test01/triggeredjob-02 -appService-test01/continuousjob-01 -appService-test01/continuousjob-02 -``` - -This command lists webjobs for an app. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IWebJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebApp.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebApp.md deleted file mode 100644 index 4a4bdfa5df52..000000000000 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebApp.md +++ /dev/null @@ -1,576 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebapp -schema: 2.0.0 ---- - -# New-AzStaticWebApp - -## SYNOPSIS -Description for Creates a new static site in an existing resource group, or updates an existing static site. - -## SYNTAX - -``` -New-AzStaticWebApp -Name -ResourceGroupName -Location [-SubscriptionId ] - [-AllowConfigFileUpdate] [-ApiBuildCommand ] [-ApiLocation ] [-AppArtifactLocation ] - [-AppBuildCommand ] [-AppLocation ] [-Branch ] [-Capacity ] - [-ForkRepositoryDescription ] [-ForkRepositoryIsPrivate] [-ForkRepositoryName ] - [-ForkRepositoryOwner ] [-GithubActionSecretNameOverride ] - [-IdentityType ] [-IdentityUserAssignedIdentity ] [-Kind ] - [-OutputLocation ] [-RepositoryToken ] [-RepositoryUrl ] - [-SkipGithubActionWorkflowGeneration] [-SkuName ] - [-StagingEnvironmentPolicy ] [-Tag ] [-TemplateRepositoryUrl ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Creates a new static site in an existing resource group, or updates an existing static site. - -## EXAMPLES - -### Example 1: Create a new static site in an existing resource group, or updates an existing static site -```powershell -New-AzStaticWebApp -ResourceGroupName 'azure-rg-test' -Name 'staticweb-45asde' -Location 'Central US' -RepositoryUrl 'https://github.com/LucasYao93/blazor-starter' -RepositoryToken 'githubAccessToken' -Branch 'branch02' -AppLocation 'Client' -ApiLocation 'Api' -OutputLocation 'wwwroot' -SkuName 'Standard' -``` - -```output -Kind Location Name Type ----- -------- ---- ---- - Central US staticweb-45asde Microsoft.Web/staticSites -``` - -This command creates a new static site in an existing resource group, or updates an existing static site. - -### Example 2: Create a new static site in an existing resource group through specified template repository -```powershell -New-AzStaticWebApp -ResourceGroupName 'azure-rg-test' -Name staticweb-pwsh01 -Location "Central US" -RepositoryToken 'xxxxxxxxxxxxxxxxx' -TemplateRepositoryUrl 'https://github.com/staticwebdev/blazor-starter' -ForkRepositoryDescription "Test template repository function of the azure static web." -ForkRepositoryName "test-blazor-starter" -ForkRepositoryOwner 'LucasYao93' -Branch 'main' -AppLocation 'Client' -ApiLocation 'Api' -OutputLocation 'wwwroot' -SkuName 'Standard' -``` - -```output -Kind Location Name Type ----- -------- ---- ---- - Central US staticweb-pwsh01 Microsoft.Web/staticSites -``` - -This command creates a new static site in an existing resource group, or updates an existing static site through specified template repository. - -## PARAMETERS - -### -AllowConfigFileUpdate -\false\ if config file is locked for this static web app; otherwise, \true\. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiBuildCommand -A custom command to run during deployment of the Azure Functions API application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiLocation -The path to the api code within the repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppArtifactLocation -Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppBuildCommand -A custom command to run during deployment of the static content application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppLocation -The path to the app code within the repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Branch -The target branch in the repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Capacity -Current number of instances assigned to the resource. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForkRepositoryDescription -Description of the newly generated repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForkRepositoryIsPrivate -Whether or not the newly generated repository is a private repository. -Defaults to false (i.e. -public). - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForkRepositoryName -Name of the newly generated repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForkRepositoryOwner -Owner of the newly generated repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GithubActionSecretNameOverride -Github Action secret name override. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityType -Type of managed service identity. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ManagedServiceIdentityType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityUserAssignedIdentity -The list of user assigned identities associated with the resource. -The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Kind -Kind of resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Resource Location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site to create or update. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputLocation -The output path of the app after building. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RepositoryToken -A user's github repository token. -This is used to setup the Github Actions workflow file and API secrets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RepositoryUrl -URL for the repository of the static site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipGithubActionWorkflowGeneration -Skip Github Action workflow generation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuName -Name of the resource SKU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StagingEnvironmentPolicy -State indicating whether staging environments are allowed or not allowed for a static web app. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy -Parameter Sets: (All) -Aliases: - -Required: False -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). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateRepositoryUrl -URL of the template repository. -The newly generated repository will be based on this one. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md deleted file mode 100644 index c46ad808425b..000000000000 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappbuildappsetting -schema: 2.0.0 ---- - -# New-AzStaticWebAppBuildAppSetting - -## SYNOPSIS -Description for Creates or updates the app settings of a static site build. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzStaticWebAppBuildAppSetting -EnvironmentName -Name -ResourceGroupName - [-SubscriptionId ] [-AppSetting ] [-Kind ] [-DefaultProfile ] [-Confirm] - [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppBuildAppSetting -InputObject [-AppSetting ] [-Kind ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Creates or updates the app settings of a static site build. - -## EXAMPLES - -### Example 1: Create or updates the app settings of a static site build -```powershell -New-AzStaticWebAppBuildAppSetting -ResourceGroupName azure-rg-test -Name staticweb-pwsh01 -EnvironmentName 'default' -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' } -``` - -```output -Kind Name Type ----- ---- ---- - appsettings Microsoft.Web/staticSites/builds/config -``` - -This command creates or updates the app settings of a static site build. - -### Example 2: Create or updates the app settings of a static site build by pipeline -```powershell -Get-AzStaticWebAppBuildAppSetting -ResourceGroupName resourceGroup -Name taticweb00 -EnvironmentName 'default' | New-AzStaticWebAppBuildAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' } -``` - -```output -Kind Name Type ----- ---- ---- - appsettings Microsoft.Web/staticSites/builds/config -``` - -This command creates or updates the app settings of a static site by pipeline build. - -## PARAMETERS - -### -AppSetting -Settings. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -The stage site identifier. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Kind -Kind of resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md deleted file mode 100644 index 7d4a0fd1a3fb..000000000000 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappbuildfunctionappsetting -schema: 2.0.0 ---- - -# New-AzStaticWebAppBuildFunctionAppSetting - -## SYNOPSIS -Description for Creates or updates the function app settings of a static site build. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -Name -ResourceGroupName - [-SubscriptionId ] [-AppSetting ] [-Kind ] [-DefaultProfile ] [-Confirm] - [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppBuildFunctionAppSetting -InputObject [-AppSetting ] - [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Creates or updates the function app settings of a static site build. - -## EXAMPLES - -### Example 1: Create or updates the app settings of a static site build -```powershell -New-AzStaticWebAppBuildFunctionAppSetting -ResourceGroupName azure-rg-test -Name staticweb-pwsh01 -EnvironmentName 'default' -AppSetting @{'functionapp01' = 'value01'; 'functionapp02' = 'value02' } -``` - -```output -Kind Name Type ----- ---- ---- - appsettings Microsoft.Web/staticSites/builds/config -``` - -This command creates or updates the app settings of a static site build. - -### Example 2: Create or updates the app settings of a static site build by pipeline -```powershell -Get-AzStaticWebAppBuildFunctionAppSetting -ResourceGroupName resourceGroup -Name staticweb01 -EnvironmentName 'default' | New-AzStaticWebAppBuildFunctionAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' } -``` - -```output -Kind Name Type ----- ---- ---- - appsettings Microsoft.Web/staticSites/builds/config -``` - -This command creates or updates the app settings of a static site build by pipeline. - -## PARAMETERS - -### -AppSetting -Settings. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -The stage site identifier. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Kind -Kind of resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppCustomDomain.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppCustomDomain.md deleted file mode 100644 index d405d9639a11..000000000000 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppCustomDomain.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappcustomdomain -schema: 2.0.0 ---- - -# New-AzStaticWebAppCustomDomain - -## SYNOPSIS -Description for Creates a new static site custom domain in an existing resource group and static site. - -## SYNTAX - -``` -New-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName - [-SubscriptionId ] [-Kind ] [-ValidationMethod ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Creates a new static site custom domain in an existing resource group and static site. - -## EXAMPLES - -### Example 1: Create a new static site custom domain in an existing resource group and static site -```powershell -New-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName 'www01.azpstest.net' -``` - -```output -Kind Name Type ----- ---- ---- - www01.azpstest.net Microsoft.Web/staticSites/customDomains -``` - -This command creates a new static site custom domain in an existing resource group and static site. -First, Need to [configure dns provider](https://learn.microsoft.com/en-us/azure/static-web-apps/custom-domain#configure-dns-provider) for static site. - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -The custom domain to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Kind -Kind of resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidationMethod -Validation method for adding a custom domain - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteCustomDomainOverviewArmResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md deleted file mode 100644 index 30a6287d7635..000000000000 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappfunctionappsetting -schema: 2.0.0 ---- - -# New-AzStaticWebAppFunctionAppSetting - -## SYNOPSIS -Description for Creates or updates the function app settings of a static site. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-SubscriptionId ] - [-AppSetting ] [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] - [] -``` - -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppFunctionAppSetting -InputObject [-AppSetting ] - [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Creates or updates the function app settings of a static site. - -## EXAMPLES - -### Example 1: Create or updates the function app settings of a static site -```powershell -New-AzStaticWebAppFunctionAppSetting -ResourceGroupName azure-rg-test -Name staticweb-pwsh01 -AppSetting @{'function01' = 'value01'; 'function02' = 'value02' } -``` - -```output -Kind Name Type ----- ---- ---- - appsettings Microsoft.Web/staticSites/config -``` - -This command creates or updates the function app settings of a static site. - -### Example 2: Create or updates the function app settings of a static site by pipeline -```powershell -Get-AzStaticWebAppFunctionAppSetting -ResourceGroupName resourceGroup -Name staticweb01 | New-AzStaticWebAppFunctionAppSetting -AppSetting @{'function01' = 'value01'; 'function02' = 'value02' } -``` - -```output -Kind Name Type ----- ---- ---- - appsettings Microsoft.Web/staticSites/config -``` - -This command creates or updates the function app settings of a static site by pipeline. - -## PARAMETERS - -### -AppSetting -Settings. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Kind -Kind of resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md deleted file mode 100644 index dfe6b2b317a9..000000000000 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappsetting -schema: 2.0.0 ---- - -# New-AzStaticWebAppSetting - -## SYNOPSIS -Description for Creates or updates the app settings of a static site. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzStaticWebAppSetting -Name -ResourceGroupName [-SubscriptionId ] - [-AppSetting ] [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] - [] -``` - -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppSetting -InputObject [-AppSetting ] [-Kind ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Creates or updates the app settings of a static site. - -## EXAMPLES - -### Example 1: Create or updates the app settings of a static site -```powershell -New-AzStaticWebAppSetting -ResourceGroupName resourceGroup -Name staticweb01 -AppSetting @{'function01' = 'value01'; 'function02' = 'value02' } -``` - -```output -Kind Name Type ----- ---- ---- - appsettings Microsoft.Web/staticSites/config -``` - -This command creates or updates the app settings of a static site. - -### Example 2: Create or updates the app settings of a static site by pipeline. -```powershell -Get-AzStaticWebAppSetting -ResourceGroupName resourceGroup -Name staticweb01 | New-AzStaticWebAppSetting -AppSetting @{'function01' = 'value01'; 'function02' = 'value02' } -``` - -```output -Kind Name Type ----- ---- ---- - appsettings Microsoft.Web/staticSites/config -``` - -This command creates or updates the app settings of a static site by pipeline. - -## PARAMETERS - -### -AppSetting -Settings. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Kind -Kind of resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md deleted file mode 100644 index 79aff985797b..000000000000 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappuserroleinvitationlink -schema: 2.0.0 ---- - -# New-AzStaticWebAppUserRoleInvitationLink - -## SYNOPSIS -Description for Creates an invitation link for a user with the role - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName [-SubscriptionId ] - [-Domain ] [-Kind ] [-NumHoursToExpiration ] [-Provider ] [-Role ] - [-UserDetail ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppUserRoleInvitationLink -InputObject [-Domain ] [-Kind ] - [-NumHoursToExpiration ] [-Provider ] [-Role ] [-UserDetail ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Creates an invitation link for a user with the role - -## EXAMPLES - -### Example 1: Create an invitation link for a user with the role -```powershell -New-AzStaticWebAppUserRoleInvitationLink -ResourceGroupName azure-rg-test -Name staticweb-pwsh02 -Domain 'xxxxxxxxx.azurestaticapps.net' -Provider 'github' -UserDetail 'UserName' -Role 'reader' -NumHoursToExpiration 1 -``` - -```output -Kind Name Type ----- ---- ---- - 078284a9-ce47-4aa5-b54c-2e55a67dd53c Microsoft.Web/staticSites/invitations -``` - -This command creates an invitation link for a user with the role. - -### Example 2: Create an invitation link for a user with the role by pipeline -```powershell -$web = Get-AzStaticWebApp -ResourceGroupName resourceGroup -Name staticweb00 -New-AzStaticWebAppUserRoleInvitationLink -InputObject $web -Domain 'Hostname' -Provider 'github' -UserDetail 'UserName' -Role 'admin,contributor' -NumHoursToExpiration 1 - -``` - -This command creates an invitation link for a user with the role by pipeline. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The domain name for the static site custom domain. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Kind -Kind of resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumHoursToExpiration -The number of hours the sas token stays valid - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Provider -The identity provider for the static site user. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Role -The roles for the static site user, in free-form string format - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -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). - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserDetail -The user id for the static site user. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserInvitationResponseResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Register-AzStaticWebAppUserProvidedFunctionApp.md b/src/Websites/Websites.Autorest/docs/Register-AzStaticWebAppUserProvidedFunctionApp.md deleted file mode 100644 index 83ec7279a962..000000000000 --- a/src/Websites/Websites.Autorest/docs/Register-AzStaticWebAppUserProvidedFunctionApp.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/register-azstaticwebappuserprovidedfunctionapp -schema: 2.0.0 ---- - -# Register-AzStaticWebAppUserProvidedFunctionApp - -## SYNOPSIS -Description for Register a user provided function app with a static site build - -## SYNTAX - -### RegisterExpanded1 (Default) -``` -Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name - -ResourceGroupName [-SubscriptionId ] [-Forced] [-FunctionAppRegion ] - [-FunctionAppResourceId ] [-Kind ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] - [-WhatIf] [] -``` - -### RegisterExpanded -``` -Register-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -FunctionAppName - -Name -ResourceGroupName [-SubscriptionId ] [-Forced] [-FunctionAppRegion ] - [-FunctionAppResourceId ] [-Kind ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] - [-WhatIf] [] -``` - -## 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 -```powershell -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' -``` - -```output -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 -```powershell -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 -``` - -```output -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 - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -The stage site identifier. - -```yaml -Type: System.String -Parameter Sets: RegisterExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forced -Specify \true\ 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 \false\. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -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 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Kind -Kind of resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserProvidedFunctionAppArmResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebApp.md b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebApp.md deleted file mode 100644 index 45b6636b9864..000000000000 --- a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebApp.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebapp -schema: 2.0.0 ---- - -# Remove-AzStaticWebApp - -## SYNOPSIS -Description for Deletes a static site. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzStaticWebApp -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-AzStaticWebApp -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Deletes a static site. - -## EXAMPLES - -### Example 1: Delete a static site -```powershell -Remove-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb01 - -``` - -This command deletes a static site. - -### Example 2: Delete a static site by pipeline -```powershell -Get-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb02 | Remove-AzStaticWebApp - -``` - -This command deletes a static site by pipeline. - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the static site to delete. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppAttachedRepository.md b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppAttachedRepository.md deleted file mode 100644 index 122f79243f1e..000000000000 --- a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppAttachedRepository.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebappattachedrepository -schema: 2.0.0 ---- - -# Remove-AzStaticWebAppAttachedRepository - -## SYNOPSIS -Description for Detaches a static site. - -## SYNTAX - -### Detach (Default) -``` -Remove-AzStaticWebAppAttachedRepository -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DetachViaIdentity -``` -Remove-AzStaticWebAppAttachedRepository -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Detaches a static site. - -## EXAMPLES - -### Example 1: Remove repository of static site -```powershell -Remove-AzStaticWebAppAttachedRepository -ResourceGroupName azure-rg-test -Name staticweb-portal01 - -``` - -This command removes repository of static site. - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: DetachViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the static site to detach. - -```yaml -Type: System.String -Parameter Sets: Detach -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Detach -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Detach -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppBuild.md b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppBuild.md deleted file mode 100644 index 0e6614eb4800..000000000000 --- a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppBuild.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebappbuild -schema: 2.0.0 ---- - -# Remove-AzStaticWebAppBuild - -## SYNOPSIS -Description for Deletes a static site build. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzStaticWebAppBuild -EnvironmentName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-AzStaticWebAppBuild -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Deletes a static site build. - -## EXAMPLES - -### Example 1: Delete a static site build -```powershell -Remove-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal01 -EnvironmentName '2' - -``` - -This command deletes a static site build. - -### Example 2: Delete a static site build by pipeline -```powershell -Get-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal01 -EnvironmentName '3' | Remove-AzStaticWebAppBuild - -``` - -This command deletes a static site build by pipeline. - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -The stage site identifier. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppCustomDomain.md b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppCustomDomain.md deleted file mode 100644 index 6f5fcfa334f1..000000000000 --- a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppCustomDomain.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebappcustomdomain -schema: 2.0.0 ---- - -# Remove-AzStaticWebAppCustomDomain - -## SYNOPSIS -Description for Deletes a custom domain. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-AzStaticWebAppCustomDomain -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Deletes a custom domain. - -## EXAMPLES - -### Example 1: Delete a custom domain -```powershell -Remove-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName domainName - -``` - -This command deletes a custom domain. - -### Example 2: Delete a custom domain by pipeline -```powershell -Get-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName domainName | Remove-AzStaticWebAppCustomDomain - -``` - -This command deletes a custom domain by pipeline. - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -The custom domain to delete. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppUser.md b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppUser.md deleted file mode 100644 index f9ee6cee4f76..000000000000 --- a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppUser.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebappuser -schema: 2.0.0 ---- - -# Remove-AzStaticWebAppUser - -## SYNOPSIS -Description for Deletes the user entry from the static site. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzStaticWebAppUser -AuthProvider -Name -ResourceGroupName -UserId - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-AzStaticWebAppUser -InputObject [-DefaultProfile ] [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -Description for Deletes the user entry from the static site. - -## EXAMPLES - -### Example 1: Delete a user entry from the static site -```powershell -Remove-AzStaticWebAppUser -ResourceGroupName resourceGroup -Name staticweb01 -Authprovider 'all' -UserId 'xxxxxxxx' - -``` - -This command deletes the user entry from the static site. - -### Example 2: Delete all users from the static site -```powershell -$userList = Get-AzStaticWebAppUser -ResourceGroupName resourceGroup -Name staticweb01 -Authprovider all -Remove-AzStaticWebAppUser -InputObject $userList - -``` - -This command deletes all users from the static site. - -## PARAMETERS - -### -AuthProvider -The auth provider for this user. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the staticsite. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The user id of the user. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzWebAppContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Remove-AzWebAppContinuousWebJob.md deleted file mode 100644 index 28043e274600..000000000000 --- a/src/Websites/Websites.Autorest/docs/Remove-AzWebAppContinuousWebJob.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebappcontinuouswebjob -schema: 2.0.0 ---- - -# Remove-AzWebAppContinuousWebJob - -## SYNOPSIS -Delete a continuous web job for an app. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzWebAppContinuousWebJob -AppName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-AzWebAppContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Delete a continuous web job for an app. - -## EXAMPLES - -### Example 1: Delete a continuous web job for an app -```powershell -Remove-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 - -``` - -This command deletes a continuous web job for an app. - -### Example 2: Delete a continuous web job for an app by pipeline -```powershell -Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-02 | Remove-AzWebAppContinuousWebJob - -``` - -This command deletes a continuous web job for an app by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotContinuousWebJob.md deleted file mode 100644 index 515590d6b5b2..000000000000 --- a/src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotContinuousWebJob.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebappslotcontinuouswebjob -schema: 2.0.0 ---- - -# Remove-AzWebAppSlotContinuousWebJob - -## SYNOPSIS -Delete a continuous web job for a deployment slot. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzWebAppSlotContinuousWebJob -AppName -Name -ResourceGroupName - -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-AzWebAppSlotContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Delete a continuous web job for a deployment slot. - -## EXAMPLES - -### Example 1: Delete a continuous web job for a deployment slot -```powershell -Remove-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-03 - -``` - -This command deletes a continuous web job for a deployment slot. - -### Example 2: Delete a continuous web job for a deployment slot by pipeline -```powershell -Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-04 | Remove-AzWebAppSlotContinuousWebJob - -``` - -This command deletes a continuous web job for a deployment slot by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlotName -Name of the deployment slot. -If a slot is not specified, the API deletes a deployment for the production slot. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotTriggeredWebJob.md b/src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotTriggeredWebJob.md deleted file mode 100644 index 865cff45a9a3..000000000000 --- a/src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotTriggeredWebJob.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebappslottriggeredwebjob -schema: 2.0.0 ---- - -# Remove-AzWebAppSlotTriggeredWebJob - -## SYNOPSIS -Delete a triggered web job for a deployment slot. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzWebAppSlotTriggeredWebJob -AppName -Name -ResourceGroupName - -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-AzWebAppSlotTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Delete a triggered web job for a deployment slot. - -## EXAMPLES - -### Example 1: Delete a triggered web job for a deployment slot -```powershell -Remove-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 - -``` - -This command deletes a triggered web job for a deployment slot. - -### Example 2: Delete a triggered web job for a deployment slot by pipeline -```powershell -Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-04 | Remove-AzWebAppSlotTriggeredWebJob - -``` - -This command deletes a triggered web job for a deployment slot by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlotName -Name of the deployment slot. -If a slot is not specified, the API deletes web job for the production slot. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzWebAppTriggeredWebJob.md b/src/Websites/Websites.Autorest/docs/Remove-AzWebAppTriggeredWebJob.md deleted file mode 100644 index b34d924ae7e3..000000000000 --- a/src/Websites/Websites.Autorest/docs/Remove-AzWebAppTriggeredWebJob.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebapptriggeredwebjob -schema: 2.0.0 ---- - -# Remove-AzWebAppTriggeredWebJob - -## SYNOPSIS -Delete a triggered web job for an app. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzWebAppTriggeredWebJob -AppName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-AzWebAppTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Delete a triggered web job for an app. - -## EXAMPLES - -### Example 1: Delete a triggered web job for an app -```powershell -Remove-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 - -``` - -This command deletes a triggered web job for an app. - -### Example 2: Delete a triggered web job for an app by pipeline -```powershell -Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-02 | Remove-AzWebAppTriggeredWebJob - -``` - -This command deletes a triggered web job for an app by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Reset-AzStaticWebAppApiKey.md b/src/Websites/Websites.Autorest/docs/Reset-AzStaticWebAppApiKey.md deleted file mode 100644 index 769685f8f63d..000000000000 --- a/src/Websites/Websites.Autorest/docs/Reset-AzStaticWebAppApiKey.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/reset-azstaticwebappapikey -schema: 2.0.0 ---- - -# Reset-AzStaticWebAppApiKey - -## SYNOPSIS -Description for Resets the api key for an existing static site. - -## SYNTAX - -### ResetExpanded (Default) -``` -Reset-AzStaticWebAppApiKey -Name -ResourceGroupName [-SubscriptionId ] - [-Kind ] [-RepositoryToken ] [-ShouldUpdateRepository] [-DefaultProfile ] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### ResetViaIdentityExpanded -``` -Reset-AzStaticWebAppApiKey -InputObject [-Kind ] [-RepositoryToken ] - [-ShouldUpdateRepository] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Resets the api key for an existing static site. - -## EXAMPLES - -### Example 1: Reset the api key for an existing static site. -```powershell -Reset-AzStaticWebAppApiKey -ResourceGroupName azure-rg-test -Name staticweb-portal01 - -``` - -This command resets the api key for an existing static site. - -### Example 2: Reset the api key for an existing static site by pipeline -```powershell -Get-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb-portal01 | Reset-AzStaticWebAppApiKey - -``` - -This command resets the api key for an existing static site by pipeline. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: ResetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Kind -Kind of resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: ResetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RepositoryToken -The token which proves admin privileges to the repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: ResetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShouldUpdateRepository -Determines whether the repository should be updated with the new properties. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -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). - -```yaml -Type: System.String -Parameter Sets: ResetExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Start-AzWebAppContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Start-AzWebAppContinuousWebJob.md deleted file mode 100644 index e5fb4b1aa60d..000000000000 --- a/src/Websites/Websites.Autorest/docs/Start-AzWebAppContinuousWebJob.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebappcontinuouswebjob -schema: 2.0.0 ---- - -# Start-AzWebAppContinuousWebJob - -## SYNOPSIS -Start a continuous web job for an app. - -## SYNTAX - -### Start (Default) -``` -Start-AzWebAppContinuousWebJob -AppName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### StartViaIdentity -``` -Start-AzWebAppContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Start a continuous web job for an app. - -## EXAMPLES - -### Example 1: Start a continuous web job for an app -```powershell -Start-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 - -``` - -This command starts a continuous web job for an app. - -### Example 2: Start a continuous web job for an app by pipeline -```powershell -Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 | Start-AzWebAppContinuousWebJob - -``` - -This command starts a continuous web job for an app by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Start -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: StartViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Start -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Start -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Start -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotContinuousWebJob.md deleted file mode 100644 index 4d2bc30c460e..000000000000 --- a/src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotContinuousWebJob.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebappslotcontinuouswebjob -schema: 2.0.0 ---- - -# Start-AzWebAppSlotContinuousWebJob - -## SYNOPSIS -Start a continuous web job for a deployment slot. - -## SYNTAX - -### Start (Default) -``` -Start-AzWebAppSlotContinuousWebJob -AppName -Name -ResourceGroupName - -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### StartViaIdentity -``` -Start-AzWebAppSlotContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Start a continuous web job for a deployment slot. - -## EXAMPLES - -### Example 1: Start a continuous web job for a deployment slot -```powershell -Start-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-01 - -``` - -This command starts a continuous web job for an app. - -### Example 2: Start a continuous web job for a deployment slot by pipeline -```powershell -Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-01 | Start-AzWebAppSlotContinuousWebJob - -``` - -This command starts a continuous web job for a deployment slot by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Start -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: StartViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Start -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Start -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlotName -Name of the deployment slot. -If a slot is not specified, the API deletes a deployment for the production slot. - -```yaml -Type: System.String -Parameter Sets: Start -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Start -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotTriggeredWebJob.md b/src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotTriggeredWebJob.md deleted file mode 100644 index 6281ba456555..000000000000 --- a/src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotTriggeredWebJob.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebappslottriggeredwebjob -schema: 2.0.0 ---- - -# Start-AzWebAppSlotTriggeredWebJob - -## SYNOPSIS -Run a triggered web job for a deployment slot. - -## SYNTAX - -### Run (Default) -``` -Start-AzWebAppSlotTriggeredWebJob -AppName -Name -ResourceGroupName - -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### RunViaIdentity -``` -Start-AzWebAppSlotTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Run a triggered web job for a deployment slot. - -## EXAMPLES - -### Example 1: Run a triggered web job for a deployment slot -```powershell -Start-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 - -``` - -This command runs a triggered web job for a deployment slot. - -### Example 2: Run a triggered web job for a deployment slot by pipeline -```powershell -Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 | Start-AzWebAppSlotTriggeredWebJob - -``` - -This command runs a triggered web job for a deployment slot by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Run -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: RunViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Run -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Run -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlotName -Name of the deployment slot. -If a slot is not specified, the API uses the production slot. - -```yaml -Type: System.String -Parameter Sets: Run -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Run -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Start-AzWebAppTriggeredWebJob.md b/src/Websites/Websites.Autorest/docs/Start-AzWebAppTriggeredWebJob.md deleted file mode 100644 index e8ce861de212..000000000000 --- a/src/Websites/Websites.Autorest/docs/Start-AzWebAppTriggeredWebJob.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebapptriggeredwebjob -schema: 2.0.0 ---- - -# Start-AzWebAppTriggeredWebJob - -## SYNOPSIS -Run a triggered web job for an app. - -## SYNTAX - -### Run (Default) -``` -Start-AzWebAppTriggeredWebJob -AppName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### RunViaIdentity -``` -Start-AzWebAppTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Run a triggered web job for an app. - -## EXAMPLES - -### Example 1: Run a triggered web job for an app -```powershell -Start-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 - -``` - -This command runs a triggered web job for an app. - -### Example 2: Run a triggered web job for an app by pipeline -```powershell -Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 | Start-AzWebAppTriggeredWebJob - -``` - -This command runs a triggered web job for an app by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Run -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: RunViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Run -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Run -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Run -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Stop-AzWebAppContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Stop-AzWebAppContinuousWebJob.md deleted file mode 100644 index ff334e8de762..000000000000 --- a/src/Websites/Websites.Autorest/docs/Stop-AzWebAppContinuousWebJob.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/stop-azwebappcontinuouswebjob -schema: 2.0.0 ---- - -# Stop-AzWebAppContinuousWebJob - -## SYNOPSIS -Stop a continuous web job for an app. - -## SYNTAX - -### Stop (Default) -``` -Stop-AzWebAppContinuousWebJob -AppName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### StopViaIdentity -``` -Stop-AzWebAppContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Stop a continuous web job for an app. - -## EXAMPLES - -### Example 1: Stop a continuous web job for an app -```powershell -Stop-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 - -``` - -This command stops a continuous web job for an app. - -### Example 2: Stop a continuous web job for an app by pipeline -```powershell -Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 | Stop-AzWebAppContinuousWebJob - -``` - -This command stops a continuous web job for an app by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Stop -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: StopViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Stop -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Stop -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Stop -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Stop-AzWebAppSlotContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Stop-AzWebAppSlotContinuousWebJob.md deleted file mode 100644 index efe345ae63ed..000000000000 --- a/src/Websites/Websites.Autorest/docs/Stop-AzWebAppSlotContinuousWebJob.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/stop-azwebappslotcontinuouswebjob -schema: 2.0.0 ---- - -# Stop-AzWebAppSlotContinuousWebJob - -## SYNOPSIS -Stop a continuous web job for a deployment slot. - -## SYNTAX - -### Stop (Default) -``` -Stop-AzWebAppSlotContinuousWebJob -AppName -Name -ResourceGroupName - -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### StopViaIdentity -``` -Stop-AzWebAppSlotContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Stop a continuous web job for a deployment slot. - -## EXAMPLES - -### Example 1: Stop a continuous web job for a deployment slot -```powershell -Stop-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-01 - -``` - -This command stops a continuous web job for an app. - -### Example 2: Stop a continuous web job for a deployment slot by pipeline -```powershell -Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-01 | Stop-AzWebAppSlotContinuousWebJob - -``` - -This command stops a continuous web job for a deployment slot by pipeline. - -## PARAMETERS - -### -AppName -Site name. - -```yaml -Type: System.String -Parameter Sets: Stop -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: StopViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of Web Job. - -```yaml -Type: System.String -Parameter Sets: Stop -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Stop -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlotName -Name of the deployment slot. -If a slot is not specified, the API deletes a deployment for the production slot. - -```yaml -Type: System.String -Parameter Sets: Stop -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Stop -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Test-AzStaticWebAppCustomDomain.md b/src/Websites/Websites.Autorest/docs/Test-AzStaticWebAppCustomDomain.md deleted file mode 100644 index 1f7bbf86233b..000000000000 --- a/src/Websites/Websites.Autorest/docs/Test-AzStaticWebAppCustomDomain.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/test-azstaticwebappcustomdomain -schema: 2.0.0 ---- - -# Test-AzStaticWebAppCustomDomain - -## SYNOPSIS -Description for Validates a particular custom domain can be added to a static site. - -## SYNTAX - -### ValidateExpanded (Default) -``` -Test-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName - [-SubscriptionId ] [-Kind ] [-ValidationMethod ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### ValidateViaIdentityExpanded -``` -Test-AzStaticWebAppCustomDomain -InputObject [-Kind ] [-ValidationMethod ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Validates a particular custom domain can be added to a static site. - -## EXAMPLES - -### Example 1: Validate a particular custom domain can be added to a static site -```powershell -Test-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName 'www01.azpstest.net' - -``` - -This command validates a particular custom domain can be added to a static site - -### Example 2: Validate a particular custom domain can be added to a static site by pipeline -```powershell -Get-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName 'www01.azpstest.net' | Get-AzStaticWebAppCustomDomain - -``` - -This command validates a particular custom domain can be added to a static site by pipeline. - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -The custom domain to validate. - -```yaml -Type: System.String -Parameter Sets: ValidateExpanded -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: ValidateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Kind -Kind of resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: ValidateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: ValidateExpanded -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: ValidateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidationMethod -Validation method for adding a custom domain - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md b/src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md deleted file mode 100644 index 0b8b6a9130cf..000000000000 --- a/src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/unregister-azstaticwebappbuilduserprovidedfunctionapp -schema: 2.0.0 ---- - -# Unregister-AzStaticWebAppBuildUserProvidedFunctionApp - -## SYNOPSIS -Description for Detach the user provided function app from the static site build - -## SYNTAX - -### Detach (Default) -``` -Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -EnvironmentName -FunctionAppName - -Name -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DetachViaIdentity -``` -Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -InputObject - [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Detach the user provided function app from the static site build - -## EXAMPLES - -### Example 1: Unregister the user provided function app from the static site build -```powershell -Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' -EnvironmentName 'default' -FunctionAppName 'functionAppName01' - -``` - -This command unregisters the user provided function app from the static site build. - -### Example 2: Unregister the user provided function app from the static site build by pipeline -```powershell -Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' -EnvironmentName 'default' -FunctionAppName 'functionAppName01' -FunctionAppResourceId 'functionAppId01' -FunctionAppRegion 'eastus' -Forced | Unregister-AzStaticWebAppBuildUserProvidedFunctionApp - -``` - -This command unregisters the user provided function app from the static site build by pipeline. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentName -The stage site identifier. - -```yaml -Type: System.String -Parameter Sets: Detach -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FunctionAppName -Name of the function app registered with the static site build. - -```yaml -Type: System.String -Parameter Sets: Detach -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: DetachViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: Detach -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Detach -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Detach -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppUserProvidedFunctionApp.md b/src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppUserProvidedFunctionApp.md deleted file mode 100644 index b933049b0896..000000000000 --- a/src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppUserProvidedFunctionApp.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/unregister-azstaticwebappuserprovidedfunctionapp -schema: 2.0.0 ---- - -# Unregister-AzStaticWebAppUserProvidedFunctionApp - -## SYNOPSIS -Description for Detach the user provided function app from the static site - -## SYNTAX - -### Detach (Default) -``` -Unregister-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -### DetachViaIdentity -``` -Unregister-AzStaticWebAppUserProvidedFunctionApp -InputObject [-DefaultProfile ] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## 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 -```powershell -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 -```powershell -Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName $env.resourceGroup -Name $env.staticweb00 -FunctionAppName $env.functionAppName01 -FunctionAppResourceId $env.functionAppId01 -FunctionAppRegion $env.location -Forced | Unregister-AzStaticWebAppUserProvidedFunctionApp - -``` - -This command unregisters the user provided function app from the static site by pipeline. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FunctionAppName -Name of the function app registered with the static site. - -```yaml -Type: System.String -Parameter Sets: Detach -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: DetachViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: Detach -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: Detach -Aliases: - -Required: True -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). - -```yaml -Type: System.String -Parameter Sets: Detach -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Update-AzStaticWebApp.md b/src/Websites/Websites.Autorest/docs/Update-AzStaticWebApp.md deleted file mode 100644 index ea357eedcd00..000000000000 --- a/src/Websites/Websites.Autorest/docs/Update-AzStaticWebApp.md +++ /dev/null @@ -1,484 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/update-azstaticwebapp -schema: 2.0.0 ---- - -# Update-AzStaticWebApp - -## SYNOPSIS -Description for Creates a new static site in an existing resource group, or updates an existing static site. - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-AzStaticWebApp -Name -ResourceGroupName [-SubscriptionId ] - [-AllowConfigFileUpdate] [-ApiBuildCommand ] [-ApiLocation ] [-AppArtifactLocation ] - [-AppBuildCommand ] [-AppLocation ] [-Branch ] [-ForkRepositoryDescription ] - [-ForkRepositoryIsPrivate] [-ForkRepositoryName ] [-ForkRepositoryOwner ] - [-GithubActionSecretNameOverride ] [-Kind ] [-OutputLocation ] - [-RepositoryToken ] [-RepositoryUrl ] [-SkipGithubActionWorkflowGeneration] - [-StagingEnvironmentPolicy ] [-TemplateRepositoryUrl ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -### UpdateViaIdentityExpanded -``` -Update-AzStaticWebApp -InputObject [-AllowConfigFileUpdate] [-ApiBuildCommand ] - [-ApiLocation ] [-AppArtifactLocation ] [-AppBuildCommand ] [-AppLocation ] - [-Branch ] [-ForkRepositoryDescription ] [-ForkRepositoryIsPrivate] - [-ForkRepositoryName ] [-ForkRepositoryOwner ] [-GithubActionSecretNameOverride ] - [-Kind ] [-OutputLocation ] [-RepositoryToken ] [-RepositoryUrl ] - [-SkipGithubActionWorkflowGeneration] [-StagingEnvironmentPolicy ] - [-TemplateRepositoryUrl ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Creates a new static site in an existing resource group, or updates an existing static site. - -## EXAMPLES - -### Example 1: Update a static site -```powershell -Update-AzStaticWebApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' -``` - -```output -Kind Location Name Type ----- -------- ---- ---- - Central US staticweb00 Microsoft.Web/staticSites -``` - -This command updates a static site. - -### Example 2: Update a static site by pipeline -```powershell -Get-AzStaticWebApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' | Update-AzStaticWebApp -``` - -```output -Kind Location Name Type ----- -------- ---- ---- - Central US staticweb00 Microsoft.Web/staticSites -``` - -This command updates a static site by pipeline. - -## PARAMETERS - -### -AllowConfigFileUpdate -\false\ if config file is locked for this static web app; otherwise, \true\. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiBuildCommand -A custom command to run during deployment of the Azure Functions API application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiLocation -The path to the api code within the repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppArtifactLocation -Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppBuildCommand -A custom command to run during deployment of the static content application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppLocation -The path to the app code within the repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Branch -The target branch in the repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForkRepositoryDescription -Description of the newly generated repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForkRepositoryIsPrivate -Whether or not the newly generated repository is a private repository. -Defaults to false (i.e. -public). - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForkRepositoryName -Name of the newly generated repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForkRepositoryOwner -Owner of the newly generated repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GithubActionSecretNameOverride -Github Action secret name override. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Kind -Kind of resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site to create or update. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputLocation -The output path of the app after building. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RepositoryToken -A user's github repository token. -This is used to setup the Github Actions workflow file and API secrets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RepositoryUrl -URL for the repository of the static site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipGithubActionWorkflowGeneration -Skip Github Action workflow generation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StagingEnvironmentPolicy -State indicating whether staging environments are allowed or not allowed for a static web app. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy -Parameter Sets: (All) -Aliases: - -Required: False -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). - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateRepositoryUrl -URL of the template repository. -The newly generated repository will be based on this one. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/docs/Update-AzStaticWebAppUser.md b/src/Websites/Websites.Autorest/docs/Update-AzStaticWebAppUser.md deleted file mode 100644 index a70c3e4aef71..000000000000 --- a/src/Websites/Websites.Autorest/docs/Update-AzStaticWebAppUser.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: -Module Name: Az.Websites -online version: https://learn.microsoft.com/powershell/module/az.websites/update-azstaticwebappuser -schema: 2.0.0 ---- - -# Update-AzStaticWebAppUser - -## SYNOPSIS -Description for Updates a user entry with the listed roles - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-AzStaticWebAppUser -AuthProvider -Name -ResourceGroupName -UserId - [-SubscriptionId ] [-Kind ] [-Role ] [-DefaultProfile ] [-Confirm] - [-WhatIf] [] -``` - -### UpdateViaIdentityExpanded -``` -Update-AzStaticWebAppUser -InputObject [-Kind ] [-Role ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Description for Updates a user entry with the listed roles - -## EXAMPLES - -### Example 1: Update a user entry with the listed roles -```powershell -Update-AzStaticWebAppUser -ResourceGroupName azure-rg-test -Name staticweb-portal01 -Authprovider 'github' -Userid 'fa4eba85fa9f4a42b5300dc4c7bb45aa' -Role 'contributor' -``` - -```output -Kind Name Type ----- ---- ---- - fa4eba85fa9f4a42b5300dc4c7bb45aa Microsoft.Web/staticSites/users -``` - -This command updates a user entry with the listed roles. - -### Example 2: Update a user entry with the listed roles by pipeline -```powershell -Get-AzStaticWebAppUser -ResourceGroupName azure-rg-test -Name staticweb-portal01 -Authprovider 'all' | Update-AzStaticWebAppUser -Role 'contributor' -``` - -```output -Kind Name Type ----- ---- ---- - fa4eba85fa9f4a42b5300dc4c7bb45aa Microsoft.Web/staticSites/users - 8bcf2cef5f3c4c8e9a58386d62bba7c3 Microsoft.Web/staticSites/users -``` - -This command updates a user entry with the listed roles by pipeline. - -## PARAMETERS - -### -AuthProvider -The auth provider for this user. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Kind -Kind of resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the static site. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group to which the resource belongs. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Role -The roles for the static site user, in free-form string format - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -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). - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The user id of the user. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserArmResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Websites/Websites.Autorest/examples/README.md b/src/Websites/Websites.Autorest/examples/README.md new file mode 100644 index 000000000000..ac871d71fc72 --- /dev/null +++ b/src/Websites/Websites.Autorest/examples/README.md @@ -0,0 +1,11 @@ +# Examples +This directory contains examples from the exported cmdlets of the module. When `build-module.ps1` is ran, example stub files will be generated here. If your module support Azure Profiles, the example stubs will be in individual profile folders. These example stubs should be updated to show how the cmdlet is used. The examples are imported into the documentation when `generate-help.ps1` is ran. + +## Info +- Modifiable: yes +- Generated: partial +- Committed: yes +- Packaged: no + +## Purpose +This separates the example documentation details from the generated documentation information provided directly from the generated cmdlets. Since the cmdlets don't have examples from the REST spec, this provides a means to add examples easily. The example stubs provide the markdown format that is required. The 3 core elements are: the name of the example, the code information of the example, and the description of the example. That information, if the markdown format is followed, will be available to documentation generation and be part of the documents in the `..\docs` folder. \ No newline at end of file diff --git a/src/Websites/Websites.Autorest/generate-info.json b/src/Websites/Websites.Autorest/generate-info.json deleted file mode 100644 index 1a0d034b435a..000000000000 --- a/src/Websites/Websites.Autorest/generate-info.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "generate_Id": "fde66cdb-a71d-4477-a53e-b9889e16c976" -} diff --git a/src/Websites/Websites.Autorest/resources/README.md b/src/Websites/Websites.Autorest/resources/README.md new file mode 100644 index 000000000000..937f07f8fec2 --- /dev/null +++ b/src/Websites/Websites.Autorest/resources/README.md @@ -0,0 +1,11 @@ +# Resources +This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `..\custom` folder. + +## Info +- Modifiable: yes +- Generated: no +- Committed: yes +- Packaged: no + +## Purpose +Use this folder to put anything you want to keep around as part of the repository for the module, but is not something that is required for the module. For example, development files, packaged builds, or additional information. This is only intended to be used in repositories where the module's output directory is cleaned, but tangential resources for the module want to remain intact. \ No newline at end of file From 1111001e4cd710631a75801dd5870b991e960981 Mon Sep 17 00:00:00 2001 From: Qi Pan <43341456+Pan-Qi@users.noreply.github.com> Date: Wed, 30 Jul 2025 01:04:32 +1000 Subject: [PATCH 2/7] fix identity --- .../Properties/AssemblyInfo.cs | 7 +- .../custom/New-AzStaticWebApp.ps1 | 277 ++++-- .../Websites.Autorest/docs/Az.Websites.md | 163 ++++ .../docs/Get-AzStaticWebApp.md | 190 +++++ .../docs/Get-AzStaticWebAppBuild.md | 207 +++++ .../docs/Get-AzStaticWebAppBuildAppSetting.md | 161 ++++ .../docs/Get-AzStaticWebAppBuildFunction.md | 130 +++ ...t-AzStaticWebAppBuildFunctionAppSetting.md | 161 ++++ .../docs/Get-AzStaticWebAppConfiguredRole.md | 146 ++++ .../docs/Get-AzStaticWebAppCustomDomain.md | 207 +++++ .../docs/Get-AzStaticWebAppFunction.md | 110 +++ .../Get-AzStaticWebAppFunctionAppSetting.md | 146 ++++ .../docs/Get-AzStaticWebAppSecret.md | 146 ++++ .../docs/Get-AzStaticWebAppSetting.md | 146 ++++ .../docs/Get-AzStaticWebAppUser.md | 161 ++++ ...t-AzStaticWebAppUserProvidedFunctionApp.md | 281 ++++++ .../docs/Get-AzWebAppContinuousWebJob.md | 210 +++++ .../docs/Get-AzWebAppSlotContinuousWebJob.md | 247 ++++++ .../docs/Get-AzWebAppSlotTriggeredWebJob.md | 247 ++++++ .../Get-AzWebAppSlotTriggeredWebJobHistory.md | 282 ++++++ .../docs/Get-AzWebAppSlotWebJob.md | 134 +++ .../docs/Get-AzWebAppTriggeredWebJob.md | 209 +++++ .../Get-AzWebAppTriggeredWebJobHistory.md | 245 ++++++ .../docs/Get-AzWebAppWebJob.md | 118 +++ .../docs/New-AzStaticWebApp.md | 806 ++++++++++++++++++ .../docs/New-AzStaticWebAppBuildAppSetting.md | 295 +++++++ ...w-AzStaticWebAppBuildFunctionAppSetting.md | 295 +++++++ .../docs/New-AzStaticWebAppCustomDomain.md | 313 +++++++ .../New-AzStaticWebAppFunctionAppSetting.md | 256 ++++++ .../docs/New-AzStaticWebAppSetting.md | 256 ++++++ ...ew-AzStaticWebAppUserRoleInvitationLink.md | 313 +++++++ ...r-AzStaticWebAppUserProvidedFunctionApp.md | 290 +++++++ .../docs/Remove-AzStaticWebApp.md | 218 +++++ ...Remove-AzStaticWebAppAttachedRepository.md | 210 +++++ .../docs/Remove-AzStaticWebAppBuild.md | 255 ++++++ .../docs/Remove-AzStaticWebAppCustomDomain.md | 255 ++++++ .../docs/Remove-AzStaticWebAppUser.md | 261 ++++++ .../docs/Remove-AzWebAppContinuousWebJob.md | 224 +++++ .../Remove-AzWebAppSlotContinuousWebJob.md | 262 ++++++ .../Remove-AzWebAppSlotTriggeredWebJob.md | 262 ++++++ .../docs/Remove-AzWebAppTriggeredWebJob.md | 224 +++++ .../docs/Reset-AzStaticWebAppApiKey.md | 276 ++++++ .../docs/Start-AzWebAppContinuousWebJob.md | 224 +++++ .../Start-AzWebAppSlotContinuousWebJob.md | 262 ++++++ .../docs/Start-AzWebAppSlotTriggeredWebJob.md | 262 ++++++ .../docs/Start-AzWebAppTriggeredWebJob.md | 224 +++++ .../docs/Stop-AzWebAppContinuousWebJob.md | 224 +++++ .../docs/Stop-AzWebAppSlotContinuousWebJob.md | 262 ++++++ .../docs/Test-AzStaticWebAppCustomDomain.md | 369 ++++++++ ...taticWebAppBuildUserProvidedFunctionApp.md | 262 ++++++ ...r-AzStaticWebAppUserProvidedFunctionApp.md | 226 +++++ .../docs/Update-AzStaticWebApp.md | 525 ++++++++++++ .../docs/Update-AzStaticWebAppUser.md | 331 +++++++ .../Websites.Autorest/examples/README.md | 11 - .../Websites.Autorest/generate-info.json | 3 + src/Websites/Websites.sln | 129 ++- src/Websites/Websites/Az.Websites.psd1 | 14 +- src/Websites/Websites/help/Az.Websites.md | 18 +- .../Websites/help/Get-AzStaticWebApp.md | 3 +- .../Websites/help/Get-AzStaticWebAppBuild.md | 26 +- .../help/Get-AzStaticWebAppBuildAppSetting.md | 2 +- .../help/Get-AzStaticWebAppBuildFunction.md | 2 +- ...t-AzStaticWebAppBuildFunctionAppSetting.md | 2 +- .../help/Get-AzStaticWebAppConfiguredRole.md | 2 +- .../help/Get-AzStaticWebAppCustomDomain.md | 26 +- .../help/Get-AzStaticWebAppFunction.md | 2 +- .../Get-AzStaticWebAppFunctionAppSetting.md | 2 +- .../Websites/help/Get-AzStaticWebAppSecret.md | 2 +- .../help/Get-AzStaticWebAppSetting.md | 2 +- .../Websites/help/Get-AzStaticWebAppUser.md | 2 +- ...t-AzStaticWebAppUserProvidedFunctionApp.md | 50 +- .../help/Get-AzWebAppContinuousWebJob.md | 35 +- .../help/Get-AzWebAppSlotContinuousWebJob.md | 58 +- .../help/Get-AzWebAppSlotTriggeredWebJob.md | 58 +- .../Get-AzWebAppSlotTriggeredWebJobHistory.md | 85 +- .../Websites/help/Get-AzWebAppSlotWebJob.md | 2 +- .../help/Get-AzWebAppTriggeredWebJob.md | 35 +- .../Get-AzWebAppTriggeredWebJobHistory.md | 60 +- .../Websites/help/Get-AzWebAppWebJob.md | 2 +- .../Websites/help/New-AzStaticWebApp.md | 327 +++++-- .../help/New-AzStaticWebAppBuildAppSetting.md | 87 +- ...w-AzStaticWebAppBuildFunctionAppSetting.md | 85 +- .../help/New-AzStaticWebAppCustomDomain.md | 109 ++- .../New-AzStaticWebAppFunctionAppSetting.md | 61 +- .../help/New-AzStaticWebAppSetting.md | 61 +- ...ew-AzStaticWebAppUserRoleInvitationLink.md | 69 +- ...r-AzStaticWebAppUserProvidedFunctionApp.md | 63 +- .../Websites/help/Remove-AzStaticWebApp.md | 1 - ...Remove-AzStaticWebAppAttachedRepository.md | 1 - .../help/Remove-AzStaticWebAppBuild.md | 25 +- .../help/Remove-AzStaticWebAppCustomDomain.md | 25 +- .../help/Remove-AzStaticWebAppUser.md | 49 +- .../help/Remove-AzWebAppContinuousWebJob.md | 25 +- .../Remove-AzWebAppSlotContinuousWebJob.md | 49 +- .../Remove-AzWebAppSlotTriggeredWebJob.md | 49 +- .../help/Remove-AzWebAppTriggeredWebJob.md | 24 +- .../help/Reset-AzStaticWebAppApiKey.md | 57 +- .../help/Start-AzWebAppContinuousWebJob.md | 24 +- .../Start-AzWebAppSlotContinuousWebJob.md | 49 +- .../help/Start-AzWebAppSlotTriggeredWebJob.md | 49 +- .../help/Start-AzWebAppTriggeredWebJob.md | 24 +- .../help/Stop-AzWebAppContinuousWebJob.md | 24 +- .../help/Stop-AzWebAppSlotContinuousWebJob.md | 49 +- .../help/Test-AzStaticWebAppCustomDomain.md | 123 ++- ...taticWebAppBuildUserProvidedFunctionApp.md | 49 +- ...r-AzStaticWebAppUserProvidedFunctionApp.md | 25 +- .../Websites/help/Update-AzStaticWebApp.md | 106 ++- .../help/Update-AzStaticWebAppUser.md | 109 ++- 108 files changed, 14737 insertions(+), 467 deletions(-) create mode 100644 src/Websites/Websites.Autorest/docs/Az.Websites.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebApp.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuild.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildAppSetting.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunction.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunctionAppSetting.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppConfiguredRole.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppCustomDomain.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunction.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunctionAppSetting.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSecret.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSetting.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUser.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUserProvidedFunctionApp.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppContinuousWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotContinuousWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJobHistory.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJobHistory.md create mode 100644 src/Websites/Websites.Autorest/docs/Get-AzWebAppWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebApp.md create mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md create mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md create mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebAppCustomDomain.md create mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md create mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md create mode 100644 src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md create mode 100644 src/Websites/Websites.Autorest/docs/Register-AzStaticWebAppUserProvidedFunctionApp.md create mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzStaticWebApp.md create mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppAttachedRepository.md create mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppBuild.md create mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppCustomDomain.md create mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppUser.md create mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzWebAppContinuousWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotContinuousWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotTriggeredWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Remove-AzWebAppTriggeredWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Reset-AzStaticWebAppApiKey.md create mode 100644 src/Websites/Websites.Autorest/docs/Start-AzWebAppContinuousWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotContinuousWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotTriggeredWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Start-AzWebAppTriggeredWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Stop-AzWebAppContinuousWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Stop-AzWebAppSlotContinuousWebJob.md create mode 100644 src/Websites/Websites.Autorest/docs/Test-AzStaticWebAppCustomDomain.md create mode 100644 src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md create mode 100644 src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppUserProvidedFunctionApp.md create mode 100644 src/Websites/Websites.Autorest/docs/Update-AzStaticWebApp.md create mode 100644 src/Websites/Websites.Autorest/docs/Update-AzStaticWebAppUser.md delete mode 100644 src/Websites/Websites.Autorest/examples/README.md create mode 100644 src/Websites/Websites.Autorest/generate-info.json diff --git a/src/Websites/Websites.Autorest/Properties/AssemblyInfo.cs b/src/Websites/Websites.Autorest/Properties/AssemblyInfo.cs index 8a0c6f67269a..bb44d33738cd 100644 --- a/src/Websites/Websites.Autorest/Properties/AssemblyInfo.cs +++ b/src/Websites/Websites.Autorest/Properties/AssemblyInfo.cs @@ -20,7 +20,8 @@ [assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] [assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] [assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - Websites")] -[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0.0")] -[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0.0")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("3.4.1")] +[assembly: System.Reflection.AssemblyVersionAttribute("3.4.1")] [assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] -[assembly: System.CLSCompliantAttribute(false)] \ No newline at end of file +[assembly: System.CLSCompliantAttribute(false)] + diff --git a/src/Websites/Websites.Autorest/custom/New-AzStaticWebApp.ps1 b/src/Websites/Websites.Autorest/custom/New-AzStaticWebApp.ps1 index 4408d9189fb2..fec0b709d7cb 100644 --- a/src/Websites/Websites.Autorest/custom/New-AzStaticWebApp.ps1 +++ b/src/Websites/Websites.Autorest/custom/New-AzStaticWebApp.ps1 @@ -1,7 +1,6 @@ # ---------------------------------------------------------------------------------- -# -# Copyright Microsoft Corporation +# Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at @@ -11,22 +10,22 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. +# Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +# is regenerated. # ---------------------------------------------------------------------------------- <# .Synopsis -Description for Creates a new static site in an existing resource group, or updates an existing static site. +Description for create a new static site in an existing resource group, or create an existing static site. .Description -Description for Creates a new static site in an existing resource group, or updates an existing static site. +Description for create a new static site in an existing resource group, or create an existing static site. .Example -PS C:\> {{ Add code here }} - -{{ Add output here }} +New-AzStaticWebApp -ResourceGroupName 'azure-rg-test' -Name 'staticweb-45asde' -Location 'Central US' -RepositoryUrl 'https://github.com/LucasYao93/blazor-starter' -RepositoryToken 'githubAccessToken' -Branch 'branch02' -AppLocation 'Client' -ApiLocation 'Api' -OutputLocation 'wwwroot' -SkuName 'Standard' .Example -PS C:\> {{ Add code here }} - -{{ Add output here }} +New-AzStaticWebApp -ResourceGroupName 'azure-rg-test' -Name staticweb-pwsh01 -Location "Central US" -RepositoryToken 'xxxxxxxxxxxxxxxxx' -TemplateRepositoryUrl 'https://github.com/staticwebdev/blazor-starter' -ForkRepositoryDescription "Test template repository function of the azure static web." -ForkRepositoryName "test-blazor-starter" -ForkRepositoryOwner 'LucasYao93' -Branch 'main' -AppLocation 'Client' -ApiLocation 'Api' -OutputLocation 'wwwroot' -SkuName 'Standard' +.Inputs +Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity .Outputs Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteArmResource .Notes @@ -34,7 +33,23 @@ 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. -SKUCAPABILITY : Capabilities of the SKU, e.g., is traffic manager enabled +INPUTOBJECT : Identity Parameter + [Authprovider ]: The auth provider for the users. + [DomainName ]: The custom domain name. + [EnvironmentName ]: The stage site identifier. + [FunctionAppName ]: Name of the function app registered with the static site build. + [Id ]: Resource identity path + [JobHistoryId ]: History ID. + [Location ]: Location where you plan to create the static site. + [Name ]: Name of the static site. + [PrivateEndpointConnectionName ]: Name of the private endpoint connection. + [ResourceGroupName ]: Name of the resource group to which the resource belongs. + [Slot ]: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + [SubscriptionId ]: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + [Userid ]: The user id of the user. + [WebJobName ]: Name of Web Job. + +SKUCAPABILITY : Capabilities of the SKU, e.g., is traffic manager enabled? [Name ]: Name of the SKU capability. [Reason ]: Reason of the SKU capability. [Value ]: Value of the SKU capability. @@ -45,19 +60,25 @@ function New-AzStaticWebApp { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteArmResource])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( - [Parameter(Mandatory)] + [Parameter(ParameterSetName='CreateExpanded', Mandatory)] + [Parameter(ParameterSetName='CreateViaJsonFilePath', Mandatory)] + [Parameter(ParameterSetName='CreateViaJsonString', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Path')] [System.String] # Name of the static site to create or update. ${Name}, - [Parameter(Mandatory)] + [Parameter(ParameterSetName='CreateExpanded', Mandatory)] + [Parameter(ParameterSetName='CreateViaJsonFilePath', Mandatory)] + [Parameter(ParameterSetName='CreateViaJsonString', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Path')] [System.String] # Name of the resource group to which the resource belongs. ${ResourceGroupName}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaJsonFilePath')] + [Parameter(ParameterSetName='CreateViaJsonString')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] @@ -66,171 +87,286 @@ param( # 00000000-0000-0000-0000-000000000000). ${SubscriptionId}, - [Parameter(Mandatory)] + [Parameter(ParameterSetName='CreateViaIdentityExpanded', Mandatory, ValueFromPipeline)] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Path')] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity] + # Identity Parameter + ${InputObject}, + + [Parameter(ParameterSetName='CreateExpanded', Mandatory)] + [Parameter(ParameterSetName='CreateViaIdentityExpanded', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] # Resource Location. ${Location}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.Management.Automation.SwitchParameter] # false if config file is locked for this static web app; otherwise, true. ${AllowConfigFileUpdate}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] # A custom command to run during deployment of the Azure Functions API application. ${ApiBuildCommand}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] # The path to the api code within the repository. ${ApiLocation}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] # Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) ${AppArtifactLocation}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] # A custom command to run during deployment of the static content application. ${AppBuildCommand}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] # The path to the app code within the repository. ${AppLocation}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] # The target branch in the repository. ${Branch}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.Int32] # Current number of instances assigned to the resource. ${Capacity}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] + [System.Management.Automation.SwitchParameter] + # Determines whether to enable a system-assigned identity for the resource. + ${EnableSystemAssignedIdentity}, + + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] - # Github Action secret name override. - ${GithubActionSecretNameOverride}, + # Description of the newly generated repository. + ${ForkRepositoryDescription}, - [Parameter()] - [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ManagedServiceIdentityType])] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ManagedServiceIdentityType] - # Type of managed service identity. - ${IdentityType}, + [System.Management.Automation.SwitchParameter] + # Whether or not the newly generated repository is a private repository. + # Defaults to false (i.e. + # public). + ${ForkRepositoryIsPrivate}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Websites.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IManagedServiceIdentityUserAssignedIdentities]))] - [System.Collections.Hashtable] - # The list of user assigned identities associated with the resource. - # The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} - ${IdentityUserAssignedIdentity}, + [System.String] + # Name of the newly generated repository. + ${ForkRepositoryName}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] + [System.String] + # Owner of the newly generated repository. + ${ForkRepositoryOwner}, + + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] + [System.String] + # Github Action secret name override. + ${GithubActionSecretNameOverride}, + + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] # Kind of resource. ${Kind}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] # The output path of the app after building. ${OutputLocation}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] # A user's github repository token. # This is used to setup the Github Actions workflow file and API secrets. ${RepositoryToken}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] # URL for the repository of the static site. ${RepositoryUrl}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.Management.Automation.SwitchParameter] # Skip Github Action workflow generation. ${SkipGithubActionWorkflowGeneration}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [AllowEmptyCollection()] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ICapability[]] + # Capabilities of the SKU, e.g., is traffic manager enabled? + ${SkuCapability}, + + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] + [System.Int32] + # Default number of workers for this App Service plan SKU. + ${SkuCapacityDefault}, + + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] + [System.Int32] + # Maximum number of Elastic workers for this App Service plan SKU. + ${SkuCapacityElasticMaximum}, + + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] + [System.Int32] + # Maximum number of workers for this App Service plan SKU. + ${SkuCapacityMaximum}, + + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] + [System.Int32] + # Minimum number of workers for this App Service plan SKU. + ${SkuCapacityMinimum}, + + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] + [System.String] + # Available scale configurations for an App Service plan. + ${SkuCapacityScaleType}, + + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] + [System.String] + # Family code of the resource SKU. + ${SkuFamily}, + + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [AllowEmptyCollection()] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] + [System.String[]] + # Locations of the SKU. + ${SkuLocation}, + + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] # Name of the resource SKU. ${SkuName}, - [Parameter()] - [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy])] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy] + [System.String] + # Size specifier of the resource SKU. + ${SkuSize}, + + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] + [System.String] + # Service tier of the resource SKU. + ${SkuTier}, + + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.PSArgumentCompleterAttribute("Enabled", "Disabled")] + [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] + [System.String] # State indicating whether staging environments are allowed or not allowed for a static web app. ${StagingEnvironmentPolicy}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IResourceTags]))] [System.Collections.Hashtable] # Resource tags. ${Tag}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] - # Description of the newly generated repository. - ${ForkRepositoryDescription}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] - [System.Management.Automation.SwitchParameter] - # Whether or not the newly generated repository is a private repository. - # Defaults to false (i.e. - # public). - ${ForkRepositoryIsPrivate}, + # URL of the template repository. + # The newly generated repository will be based on this one. + ${TemplateRepositoryUrl}, - [Parameter()] + [Parameter(ParameterSetName='CreateExpanded')] + [Parameter(ParameterSetName='CreateViaIdentityExpanded')] + [AllowEmptyCollection()] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] - [System.String] - # Owner of the newly generated repository. - ${ForkRepositoryOwner}, + [System.String[]] + # The array of user assigned identities associated with the resource. + # The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + ${UserAssignedIdentity}, - [Parameter()] + [Parameter(ParameterSetName='CreateViaJsonFilePath', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] - # Name of the newly generated repository. - ${ForkRepositoryName}, + # Path of Json file supplied to the Create operation + ${JsonFilePath}, - [Parameter()] + [Parameter(ParameterSetName='CreateViaJsonString', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Body')] [System.String] - # URL of the template repository. - # The newly generated repository will be based on this one. - ${TemplateRepositoryUrl}, + # Json string supplied to the Create operation + ${JsonString}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Websites.Category('Azure')] [System.Management.Automation.PSObject] - # The credentials, account, tenant, and subscription used for communication with Azure. + # The DefaultProfile parameter is not functional. + # Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ${DefaultProfile}, [Parameter()] @@ -284,7 +420,6 @@ param( # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) - process { try { if(!$PSBoundParameters.ContainsKey('RepositoryUrl')) { diff --git a/src/Websites/Websites.Autorest/docs/Az.Websites.md b/src/Websites/Websites.Autorest/docs/Az.Websites.md new file mode 100644 index 000000000000..0c969cd3899f --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Az.Websites.md @@ -0,0 +1,163 @@ +--- +Module Name: Az.Websites +Module Guid: fc780f32-3a4b-4f14-a0ef-39438a2d33f8 +Download Help Link: https://learn.microsoft.com/powershell/module/az.websites +Help Version: 1.0.0.0 +Locale: en-US +--- + +# Az.Websites Module +## Description +Microsoft Azure PowerShell: Websites cmdlets + +## Az.Websites Cmdlets +### [Get-AzStaticWebApp](Get-AzStaticWebApp.md) +Description for Gets the details of a static site. + +### [Get-AzStaticWebAppBuild](Get-AzStaticWebAppBuild.md) +Description for Gets the details of a static site build. + +### [Get-AzStaticWebAppBuildAppSetting](Get-AzStaticWebAppBuildAppSetting.md) +Description for Gets the application settings of a static site build. + +### [Get-AzStaticWebAppBuildFunction](Get-AzStaticWebAppBuildFunction.md) +Description for Gets the functions of a particular static site build. + +### [Get-AzStaticWebAppBuildFunctionAppSetting](Get-AzStaticWebAppBuildFunctionAppSetting.md) +Description for Gets the application settings of a static site build. + +### [Get-AzStaticWebAppConfiguredRole](Get-AzStaticWebAppConfiguredRole.md) +Description for Lists the roles configured for the static site. + +### [Get-AzStaticWebAppCustomDomain](Get-AzStaticWebAppCustomDomain.md) +Description for Gets an existing custom domain for a particular static site. + +### [Get-AzStaticWebAppFunction](Get-AzStaticWebAppFunction.md) +Description for Gets the functions of a static site. + +### [Get-AzStaticWebAppFunctionAppSetting](Get-AzStaticWebAppFunctionAppSetting.md) +Description for Gets the application settings of a static site. + +### [Get-AzStaticWebAppSecret](Get-AzStaticWebAppSecret.md) +Description for Lists the secrets for an existing static site. + +### [Get-AzStaticWebAppSetting](Get-AzStaticWebAppSetting.md) +Description for Gets the application settings of a static site. + +### [Get-AzStaticWebAppUser](Get-AzStaticWebAppUser.md) +Description for Gets the list of users of a static site. + +### [Get-AzStaticWebAppUserProvidedFunctionApp](Get-AzStaticWebAppUserProvidedFunctionApp.md) +Description for Gets the details of the user provided function app registered with a static site build + +### [Get-AzWebAppContinuousWebJob](Get-AzWebAppContinuousWebJob.md) +Get or list continuous web for an app. + +### [Get-AzWebAppSlotContinuousWebJob](Get-AzWebAppSlotContinuousWebJob.md) +Get or list continuous web for a deployment slot. + +### [Get-AzWebAppSlotTriggeredWebJob](Get-AzWebAppSlotTriggeredWebJob.md) +Get or list triggered web for a deployment slot. + +### [Get-AzWebAppSlotTriggeredWebJobHistory](Get-AzWebAppSlotTriggeredWebJobHistory.md) +Get or list triggered web job's history for a deployment slot. + +### [Get-AzWebAppSlotWebJob](Get-AzWebAppSlotWebJob.md) +List webjobs for a deployment slot. + +### [Get-AzWebAppTriggeredWebJob](Get-AzWebAppTriggeredWebJob.md) +Get or list triggered web for an app. + +### [Get-AzWebAppTriggeredWebJobHistory](Get-AzWebAppTriggeredWebJobHistory.md) +Get or list triggered web job's history for an app. + +### [Get-AzWebAppWebJob](Get-AzWebAppWebJob.md) +List webjobs for an app. + +### [New-AzStaticWebApp](New-AzStaticWebApp.md) +Description for create a new static site in an existing resource group, or create an existing static site. + +### [New-AzStaticWebAppBuildAppSetting](New-AzStaticWebAppBuildAppSetting.md) +Description for create the app settings of a static site build. + +### [New-AzStaticWebAppBuildFunctionAppSetting](New-AzStaticWebAppBuildFunctionAppSetting.md) +Description for create the function app settings of a static site build. + +### [New-AzStaticWebAppCustomDomain](New-AzStaticWebAppCustomDomain.md) +Description for create a new static site custom domain in an existing resource group and static site. + +### [New-AzStaticWebAppFunctionAppSetting](New-AzStaticWebAppFunctionAppSetting.md) +Description for create the function app settings of a static site. + +### [New-AzStaticWebAppSetting](New-AzStaticWebAppSetting.md) +Description for create the app settings of a static site. + +### [New-AzStaticWebAppUserRoleInvitationLink](New-AzStaticWebAppUserRoleInvitationLink.md) +Description for create an invitation link for a user with the role + +### [Register-AzStaticWebAppUserProvidedFunctionApp](Register-AzStaticWebAppUserProvidedFunctionApp.md) +Description for Register a user provided function app with a static site build + +### [Remove-AzStaticWebApp](Remove-AzStaticWebApp.md) +Description for Deletes a static site. + +### [Remove-AzStaticWebAppAttachedRepository](Remove-AzStaticWebAppAttachedRepository.md) +Description for Detaches a static site. + +### [Remove-AzStaticWebAppBuild](Remove-AzStaticWebAppBuild.md) +Description for Deletes a static site build. + +### [Remove-AzStaticWebAppCustomDomain](Remove-AzStaticWebAppCustomDomain.md) +Description for Deletes a custom domain. + +### [Remove-AzStaticWebAppUser](Remove-AzStaticWebAppUser.md) +Description for Deletes the user entry from the static site. + +### [Remove-AzWebAppContinuousWebJob](Remove-AzWebAppContinuousWebJob.md) +Delete a continuous web job for an app. + +### [Remove-AzWebAppSlotContinuousWebJob](Remove-AzWebAppSlotContinuousWebJob.md) +Delete a continuous web job for a deployment slot. + +### [Remove-AzWebAppSlotTriggeredWebJob](Remove-AzWebAppSlotTriggeredWebJob.md) +Delete a triggered web job for a deployment slot. + +### [Remove-AzWebAppTriggeredWebJob](Remove-AzWebAppTriggeredWebJob.md) +Delete a triggered web job for an app. + +### [Reset-AzStaticWebAppApiKey](Reset-AzStaticWebAppApiKey.md) +Description for Resets the api key for an existing static site. + +### [Start-AzWebAppContinuousWebJob](Start-AzWebAppContinuousWebJob.md) +Start a continuous web job for an app. + +### [Start-AzWebAppSlotContinuousWebJob](Start-AzWebAppSlotContinuousWebJob.md) +Start a continuous web job for a deployment slot. + +### [Start-AzWebAppSlotTriggeredWebJob](Start-AzWebAppSlotTriggeredWebJob.md) +Run a triggered web job for a deployment slot. + +### [Start-AzWebAppTriggeredWebJob](Start-AzWebAppTriggeredWebJob.md) +Run a triggered web job for an app. + +### [Stop-AzWebAppContinuousWebJob](Stop-AzWebAppContinuousWebJob.md) +Stop a continuous web job for an app. + +### [Stop-AzWebAppSlotContinuousWebJob](Stop-AzWebAppSlotContinuousWebJob.md) +Stop a continuous web job for a deployment slot. + +### [Test-AzStaticWebAppCustomDomain](Test-AzStaticWebAppCustomDomain.md) +Description for Validates a particular custom domain can be added to a static site. + +### [Unregister-AzStaticWebAppBuildUserProvidedFunctionApp](Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md) +Description for Detach the user provided function app from the static site build + +### [Unregister-AzStaticWebAppUserProvidedFunctionApp](Unregister-AzStaticWebAppUserProvidedFunctionApp.md) +Description for Detach the user provided function app from the static site + +### [Update-AzStaticWebApp](Update-AzStaticWebApp.md) +Description for update a new static site in an existing resource group, or update an existing static site. + +### [Update-AzStaticWebAppUser](Update-AzStaticWebAppUser.md) +Description for update a user entry with the listed roles + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebApp.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebApp.md new file mode 100644 index 000000000000..1c2afe0b9b62 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebApp.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebapp +schema: 2.0.0 +--- + +# Get-AzStaticWebApp + +## SYNOPSIS +Description for Gets the details of a static site. + +## SYNTAX + +### List (Default) +``` +Get-AzStaticWebApp [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzStaticWebApp -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzStaticWebApp -InputObject [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzStaticWebApp -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Description for Gets the details of a static site. + +## EXAMPLES + +### Example 1: List all static web applications under a subscription +```powershell +Get-AzStaticWebApp +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb-portal04 Microsoft.Web/staticSites + East US 2 staticweb-portal02 Microsoft.Web/staticSites +``` + +This commands list all static web applications under a subscription. + +### Example 2: List all static web applications under a resource group +```powershell +Get-AzStaticWebApp -ResourceGroupName azure-rg-test +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb-portal04 Microsoft.Web/staticSites + East US 2 staticweb-portal02 Microsoft.Web/staticSites +``` + +This commands list all static web applications under a resource group. + +### Example 3: Get a static web application by name +```powershell +Get-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb-portal04 +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb-portal04 Microsoft.Web/staticSites +``` + +This commands gets a static web application by name. + +### Example 4: Get a static web application by pipeline +```powershell +New-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb-pwsh01 -Location eastus2 -RepositoryUrl 'https://github.com/username/RepoName' -RepositoryToken 'repoToken123' -Branch 'master' -AppLocation 'Client' -ApiLocation 'Api' -OutputLocation 'wwwroot' -SkuName 'free' | Get-AzStaticWebApp +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb-portal04 Microsoft.Web/staticSites +``` + +This commands gets a static web application by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteArmResource + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuild.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuild.md new file mode 100644 index 000000000000..4393d5e252ce --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuild.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappbuild +schema: 2.0.0 +--- + +# Get-AzStaticWebAppBuild + +## SYNOPSIS +Description for Gets the details of a static site build. + +## SYNTAX + +### List (Default) +``` +Get-AzStaticWebAppBuild -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzStaticWebAppBuild -EnvironmentName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzStaticWebAppBuild -InputObject [-DefaultProfile ] [] +``` + +### GetViaIdentityStaticSite +``` +Get-AzStaticWebAppBuild -EnvironmentName -StaticSiteInputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Description for Gets the details of a static site build. + +## EXAMPLES + +### Example 1: List all builds under a static web app +```powershell +Get-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal04 +``` + +```output +Kind Name Type +---- ---- ---- + default Microsoft.Web/staticSites/builds +``` + +This command list all builds under a static web app. +Automatically create a new build in static web app When creating a new pull request for branch. + +### Example 2: Get the details of a static site build +```powershell +Get-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal04 -EnvironmentName 'default' +``` + +```output +Kind Name Type +---- ---- ---- + default Microsoft.Web/staticSites/builds +``` + +This command gets the details of a static site build. + +### Example 3: Get the details of a static site build pipeline +```powershell +Get-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal04 | Get-AzStaticWebAppBuild +``` + +```output +Kind Name Type +---- ---- ---- + default Microsoft.Web/staticSites/builds +``` + +This command gets the details of a static site build by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteBuildArmResource + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildAppSetting.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildAppSetting.md new file mode 100644 index 000000000000..78dfd3a32b3c --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildAppSetting.md @@ -0,0 +1,161 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappbuildappsetting +schema: 2.0.0 +--- + +# Get-AzStaticWebAppBuildAppSetting + +## SYNOPSIS +Description for Gets the application settings of a static site build. + +## SYNTAX + +``` +Get-AzStaticWebAppBuildAppSetting -EnvironmentName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Gets the application settings of a static site build. + +## EXAMPLES + +### Example 1: Get the application settings of a static web build +```powershell +Get-AzStaticWebAppBuildAppSetting -ResourceGroupName azure-rg-test -Name staticweb-portal04 -EnvironmentName 'default' +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/builds/config +``` + +This command gets the application settings of a static web build. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunction.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunction.md new file mode 100644 index 000000000000..533a78ab1af9 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunction.md @@ -0,0 +1,130 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappbuildfunction +schema: 2.0.0 +--- + +# Get-AzStaticWebAppBuildFunction + +## SYNOPSIS +Description for Gets the functions of a particular static site build. + +## SYNTAX + +``` +Get-AzStaticWebAppBuildFunction -EnvironmentName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Description for Gets the functions of a particular static site build. + +## EXAMPLES + +### Example 1: List all functions of a particular static site build +```powershell +Get-AzStaticWebAppBuildFunction -ResourceGroupName lucas-rg-test -Name staticweb-portal04 -EnvironmentName 'default' +``` + +```output +Kind Name Type +---- ---- ---- + WeatherForecast Microsoft.Web/staticSites/builds/functions +``` + +This command lists all functions of a particular static site build. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteFunctionOverviewArmResource + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunctionAppSetting.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunctionAppSetting.md new file mode 100644 index 000000000000..0cfdced97141 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppBuildFunctionAppSetting.md @@ -0,0 +1,161 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappbuildfunctionappsetting +schema: 2.0.0 +--- + +# Get-AzStaticWebAppBuildFunctionAppSetting + +## SYNOPSIS +Description for Gets the application settings of a static site build. + +## SYNTAX + +``` +Get-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Gets the application settings of a static site build. + +## EXAMPLES + +### Example 1: List all application settings of a static site build +```powershell +Get-AzStaticWebAppBuildFunctionAppSetting -ResourceGroupName azure-rg-test -Name staticweb-portal04 -EnvironmentName 'default' +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/builds/config/functionappsettings +``` + +This command lists all application settings of a static site build. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppConfiguredRole.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppConfiguredRole.md new file mode 100644 index 000000000000..cb39b49d896c --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppConfiguredRole.md @@ -0,0 +1,146 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappconfiguredrole +schema: 2.0.0 +--- + +# Get-AzStaticWebAppConfiguredRole + +## SYNOPSIS +Description for Lists the roles configured for the static site. + +## SYNTAX + +``` +Get-AzStaticWebAppConfiguredRole -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Lists the roles configured for the static site. + +## EXAMPLES + +### Example 1: Lists the roles configured for the static site +```powershell +Get-AzStaticWebAppConfiguredRole -ResourceGroupName azure-rg-test -Name staticweb-portal04 +``` + +```output +Kind Name Type Property +---- ---- ---- -------- + configuredRoles Microsoft.Web/staticSites/configuredRoles {anonymous, authenticated} +``` + +This command lists the roles configured for the static site. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringList + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppCustomDomain.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppCustomDomain.md new file mode 100644 index 000000000000..dea225dee5a9 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppCustomDomain.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappcustomdomain +schema: 2.0.0 +--- + +# Get-AzStaticWebAppCustomDomain + +## SYNOPSIS +Description for Gets an existing custom domain for a particular static site. + +## SYNTAX + +### List (Default) +``` +Get-AzStaticWebAppCustomDomain -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzStaticWebAppCustomDomain -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityStaticSite +``` +Get-AzStaticWebAppCustomDomain -DomainName -StaticSiteInputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Description for Gets an existing custom domain for a particular static site. + +## EXAMPLES + +### Example 1: List all existing custom domains for a particular static site +```powershell +Get-AzStaticWebAppCustomDomain -ResourceGroupName azure-rg-test -Name staticweb00 +``` + +```output +Kind Name Type +---- ---- ---- + www01.azpstest.net Microsoft.Web/staticSites/customDomains +``` + +This command lists all existing custom domains for a particular static site. + +### Example 2: Get an existing custom domain for a particular static site +```powershell +Get-AzStaticWebAppCustomDomain -ResourceGroupName azure-rg-test -Name staticweb00 -DomainName 'www02.azpstest.net' +``` + +```output +Kind Name Type +---- ---- ---- + www02.azpstest.net Microsoft.Web/staticSites/customDomains +``` + +This command gets an existing custom domain for a particular static site. + +### Example 3: Get an existing custom domain for a particular static site by pipeline +```powershell +New-AzStaticWebAppCustomDomain -ResourceGroupName azure-rg-test -Name staticweb00 -DomainName 'www02.azpstest.net' | Get-AzStaticWebAppCustomDomain +``` + +```output +Kind Name Type +---- ---- ---- + www02.azpstest.net Microsoft.Web/staticSites/customDomains +``` + +This command gets an existing custom domain for a particular static site by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +The custom domain name. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site resource to search in. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteCustomDomainOverviewArmResource + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunction.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunction.md new file mode 100644 index 000000000000..adcd24a0e323 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunction.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappfunction +schema: 2.0.0 +--- + +# Get-AzStaticWebAppFunction + +## SYNOPSIS +Description for Gets the functions of a static site. + +## SYNTAX + +``` +Get-AzStaticWebAppFunction -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Description for Gets the functions of a static site. + +## EXAMPLES + +### Example 1: Get the functions of a static site +```powershell +Get-AzStaticWebAppFunction -ResourceGroupName azure-rg-test -Name staticweb-portal04 + +``` + +This command get the functions of a static site. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteFunctionOverviewArmResource + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunctionAppSetting.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunctionAppSetting.md new file mode 100644 index 000000000000..7faa02a7627b --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppFunctionAppSetting.md @@ -0,0 +1,146 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappfunctionappsetting +schema: 2.0.0 +--- + +# Get-AzStaticWebAppFunctionAppSetting + +## SYNOPSIS +Description for Gets the application settings of a static site. + +## SYNTAX + +``` +Get-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Gets the application settings of a static site. + +## EXAMPLES + +### Example 1: Get the application settings of a static site +```powershell +Get-AzStaticWebAppFunctionAppSetting -ResourceGroupName azure-rg-test -Name staticweb-portal04 +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/config/functionappsettings +``` + +This command gets the application settings of a static site. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSecret.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSecret.md new file mode 100644 index 000000000000..c35af5c26e83 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSecret.md @@ -0,0 +1,146 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappsecret +schema: 2.0.0 +--- + +# Get-AzStaticWebAppSecret + +## SYNOPSIS +Description for Lists the secrets for an existing static site. + +## SYNTAX + +``` +Get-AzStaticWebAppSecret -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Lists the secrets for an existing static site. + +## EXAMPLES + +### Example 1: List the secrets for an existing static site +```powershell +Get-AzStaticWebAppSecret -ResourceGroupName resourceGroup -Name staticweb-portal04 +``` + +```output +Kind Name Type +---- ---- ---- + secrets Microsoft.Web/staticSites/secrets +``` + +This command lists the secrets for an existing static site. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSetting.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSetting.md new file mode 100644 index 000000000000..fdabb440912a --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppSetting.md @@ -0,0 +1,146 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappsetting +schema: 2.0.0 +--- + +# Get-AzStaticWebAppSetting + +## SYNOPSIS +Description for Gets the application settings of a static site. + +## SYNTAX + +``` +Get-AzStaticWebAppSetting -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Gets the application settings of a static site. + +## EXAMPLES + +### Example 1: Get the application settings of a static site +```powershell +Get-AzStaticWebAppSetting -ResourceGroupName resourceGroup -Name staticweb00 +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/config +``` + +This command gets the application settings of a static site. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUser.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUser.md new file mode 100644 index 000000000000..783b5ee8005e --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUser.md @@ -0,0 +1,161 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappuser +schema: 2.0.0 +--- + +# Get-AzStaticWebAppUser + +## SYNOPSIS +Description for Gets the list of users of a static site. + +## SYNTAX + +``` +Get-AzStaticWebAppUser -AuthProvider -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Gets the list of users of a static site. + +## EXAMPLES + +### Example 1: Get the list of users of a static site +```powershell +Get-AzStaticWebAppUser -ResourceGroupName azure-rg-test -Name staticweb-portal04 -Authprovider all +``` + +```output +Kind Name Type +---- ---- ---- + c387198f0a7f44748184c9da92cbe241 Microsoft.Web/staticSites/users +``` + +This command gets the list of users of a static site. + +## PARAMETERS + +### -AuthProvider +The auth provider for the users. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserArmResource + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUserProvidedFunctionApp.md b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUserProvidedFunctionApp.md new file mode 100644 index 000000000000..d14daf23981f --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzStaticWebAppUserProvidedFunctionApp.md @@ -0,0 +1,281 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappuserprovidedfunctionapp +schema: 2.0.0 +--- + +# Get-AzStaticWebAppUserProvidedFunctionApp + +## SYNOPSIS +Description for Gets the details of the user provided function app registered with a static site build + +## SYNTAX + +### List1 (Default) +``` +Get-AzStaticWebAppUserProvidedFunctionApp -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -FunctionAppName -Name + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzStaticWebAppUserProvidedFunctionApp -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityBuild +``` +Get-AzStaticWebAppUserProvidedFunctionApp -BuildInputObject -FunctionAppName + [-DefaultProfile ] [] +``` + +### GetViaIdentityStaticSite +``` +Get-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -FunctionAppName + -StaticSiteInputObject [-DefaultProfile ] [] +``` + +### List +``` +Get-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### List2 +``` +Get-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Description for Gets the details of the user provided function app registered with a static site build + +## EXAMPLES + +### Example 1: List the details of the user provided function apps registered with a static site +```powershell +Get-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName resourceGroup -Name staticweb00 +``` + +```output +Kind Name Type +---- ---- ---- + functionApp-5enjko Microsoft.Web/staticSites/userProvidedFunctionApps +``` + +This command lists the details of the user provided function apps registered with a static site + +### Example 2: List the details of the user provided function apps registered with a static site build +```powershell +Get-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName resourceGroup -Name staticweb00 -EnvironmentName 'default' +``` + +```output +Kind Name Type +---- ---- ---- + functionApp-5enjko Microsoft.Web/staticSites/builds/userProvidedFunctionApps +``` + +This command lists the details of the user provided function apps registered with a static site build. + +### Example 3: List the details of the user provided function apps registered +```powershell +Get-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName resourceGroup -Name staticweb00 -FunctionAppName $env.functionAppName01 +``` + +```output +Kind Name Type +---- ---- ---- + functionApp-5enjko Microsoft.Web/staticSites/builds/userProvidedFunctionApps +``` + +This command lists the details of the user provided function apps registered. + +### Example 4: Get the details of the user provided function app registered with a static site build +```powershell +Get-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName resourceGroup -Name staticweb00 -EnvironmentName 'default' -FunctionAppName $env.functionAppName01 +``` + +```output +Kind Name Type +---- ---- ---- + functionApp-5enjko Microsoft.Web/staticSites/builds/userProvidedFunctionApps +``` + +This command gets the details of the user provided function app registered with a static site build. + +### Example 5: Get the details of the user provided function apps registered with a static site build by pipeline +```powershell +Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName lucas-rg-test -Name staticweb-pwsh02 -FunctionAppName functionapp-portal02 -FunctionAppResourceId '/subscriptions/xxxxxx-xx-xxx-xxxx-xxxxx/resourcegroups/xxx-xx-xxxx/providers/Microsoft.Web/sites/functionapp-portal02' -FunctionAppRegion 'Central US' -EnvironmentName 5 | Get-AzStaticWebAppUserProvidedFunctionApp +``` + +```output +Kind Name Type +---- ---- ---- + functionApp-5enjko Microsoft.Web/staticSites/builds/userProvidedFunctionApps +``` + +This command gets the details of the user provided function app registered with a static site build by pipeline. + +## PARAMETERS + +### -BuildInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityBuild +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityStaticSite, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunctionAppName +Name of the function app registered with the static site build. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityBuild, GetViaIdentityStaticSite, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: Get, List, List1, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List, List1, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1, List2 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionAppArmResource + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppContinuousWebJob.md new file mode 100644 index 000000000000..59637f301057 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzWebAppContinuousWebJob.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappcontinuouswebjob +schema: 2.0.0 +--- + +# Get-AzWebAppContinuousWebJob + +## SYNOPSIS +Get or list continuous web for an app. + +## SYNTAX + +### List (Default) +``` +Get-AzWebAppContinuousWebJob -AppName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzWebAppContinuousWebJob -AppName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzWebAppContinuousWebJob -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentitySite +``` +Get-AzWebAppContinuousWebJob -Name -SiteInputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get or list continuous web for an app. + +## EXAMPLES + +### Example 1: List continuous webs for an app +```powershell +Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/continuousjob-01 webjob-rg-test +appService-test01/continuousjob-02 webjob-rg-test +``` + +This command lists continuous webs for an app. + +### Example 2: Get continuous web for an app +```powershell +Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/continuousjob-01 webjob-rg-test +``` + +This command gets continuous web for an app. + +### Example 3: Get continuous web for an app by pipeline +```powershell +$webjob = Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 +Start-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 +$webjob.Id | Get-AzWebAppContinuousWebJob +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/continuousjob-01 webjob-rg-test +``` + +This command gets continuous web for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IContinuousWebJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotContinuousWebJob.md new file mode 100644 index 000000000000..b14a1d745cf0 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotContinuousWebJob.md @@ -0,0 +1,247 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslotcontinuouswebjob +schema: 2.0.0 +--- + +# Get-AzWebAppSlotContinuousWebJob + +## SYNOPSIS +Get or list continuous web for a deployment slot. + +## SYNTAX + +### List (Default) +``` +Get-AzWebAppSlotContinuousWebJob -AppName -ResourceGroupName -SlotName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzWebAppSlotContinuousWebJob -AppName -Name -ResourceGroupName + -SlotName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzWebAppSlotContinuousWebJob -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityContinuouswebjob +``` +Get-AzWebAppSlotContinuousWebJob -ContinuouswebjobInputObject -SlotName + [-DefaultProfile ] [] +``` + +### GetViaIdentitySite +``` +Get-AzWebAppSlotContinuousWebJob -Name -SiteInputObject -SlotName + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get or list continuous web for a deployment slot. + +## EXAMPLES + +### Example 1: List continuous webs for a deployment slot +```powershell +Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slotcontinuousjob-03 webjob-rg-test +appService-test01/slot01/slotcontinuousjob-04 webjob-rg-test +``` + +This command lists continuous webs for a deployment slot. + +### Example 2: Get continuous web for a deployment slot +```powershell +Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-03 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slotcontinuousjob-03 webjob-rg-test +``` + +This command gets continuous web for a deployment slot. + +### Example 3: Get continuous web for a deployment slot by pipeline +```powershell +$webjob = Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-03 +Start-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-03 +$webjob.Id | Get-AzWebAppSlotContinuousWebJob +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slotcontinuousjob-03 webjob-rg-test +``` + +This command gets continuous web for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinuouswebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityContinuouswebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API deletes a deployment for the production slot. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityContinuouswebjob, GetViaIdentitySite, List +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IContinuousWebJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJob.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJob.md new file mode 100644 index 000000000000..732d44138113 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJob.md @@ -0,0 +1,247 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslottriggeredwebjob +schema: 2.0.0 +--- + +# Get-AzWebAppSlotTriggeredWebJob + +## SYNOPSIS +Get or list triggered web for a deployment slot. + +## SYNTAX + +### List (Default) +``` +Get-AzWebAppSlotTriggeredWebJob -AppName -ResourceGroupName -SlotName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzWebAppSlotTriggeredWebJob -AppName -Name -ResourceGroupName + -SlotName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzWebAppSlotTriggeredWebJob -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentitySite +``` +Get-AzWebAppSlotTriggeredWebJob -Name -SiteInputObject -SlotName + [-DefaultProfile ] [] +``` + +### GetViaIdentityTriggeredwebjob +``` +Get-AzWebAppSlotTriggeredWebJob -SlotName -TriggeredwebjobInputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get or list triggered web for a deployment slot. + +## EXAMPLES + +### Example 1: List triggered webs for a deployment slot +```powershell +Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slottriggeredjob-03 webjob-rg-test +appService-test01/slot01/slottriggeredjob-04 webjob-rg-test +``` + +This command lists triggered webs for a deployment slot. + +### Example 2: Get triggered web for a deployment slot +```powershell +Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slottriggeredjob-03 webjob-rg-test +``` + +This command gets triggered web for a deployment slot. + +### Example 3: Get triggered web for a deployment slot by pipeline +```powershell +$webjob = Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 +Start-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 +$webjob.Id | Get-AzWebAppSlotTriggeredWebJob +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slottriggeredjob-03 webjob-rg-test +``` + +This command gets triggered web for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API uses the production slot. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentitySite, GetViaIdentityTriggeredwebjob, List +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggeredwebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityTriggeredwebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredWebJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJobHistory.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJobHistory.md new file mode 100644 index 000000000000..35884b8c346f --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotTriggeredWebJobHistory.md @@ -0,0 +1,282 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslottriggeredwebjobhistory +schema: 2.0.0 +--- + +# Get-AzWebAppSlotTriggeredWebJobHistory + +## SYNOPSIS +Get or list triggered web job's history for a deployment slot. + +## SYNTAX + +### List (Default) +``` +Get-AzWebAppSlotTriggeredWebJobHistory -AppName -Name -ResourceGroupName + -SlotName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzWebAppSlotTriggeredWebJobHistory -AppName -Id -Name + -ResourceGroupName -SlotName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzWebAppSlotTriggeredWebJobHistory -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityHistory +``` +Get-AzWebAppSlotTriggeredWebJobHistory -HistoryInputObject -SlotName + [-DefaultProfile ] [] +``` + +### GetViaIdentitySite +``` +Get-AzWebAppSlotTriggeredWebJobHistory -Id -Name -SiteInputObject + -SlotName [-DefaultProfile ] [] +``` + +### GetViaIdentityTriggeredwebjob +``` +Get-AzWebAppSlotTriggeredWebJobHistory -Id -SlotName + -TriggeredwebjobInputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get or list triggered web job's history for a deployment slot. + +## EXAMPLES + +### Example 1: List triggered web job's history for a deployment slot +```powershell +Get-AzWebAppSlotTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 +``` + +```output +Kind Name ResourceGroupName +---- ---- ----------------- + appService-test01/slot01/slottriggeredjob-03/202201040202032401 webjob-rg-test +``` + +This command list triggered web job's history for a deployment slot. + +### Example 2: Get triggered web job's history for a deployment slot +```powershell +Get-AzWebAppSlotTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 -Id 202201040202032401 +``` + +```output +Kind Name ResourceGroupName +---- ---- ----------------- + appService-test01/slot01/slottriggeredjob-03/202201040202032401 webjob-rg-test +``` + +This command get triggered web job's history for a deployment slot. + +### Example 3: Get triggered web job's history for a deployment slot by pipeline +```powershell +$jobs = Get-AzWebAppSlotTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 +$jobs[0].Id | Get-AzWebAppSlotTriggeredWebJobHistory +``` + +```output +Kind Name ResourceGroupName +---- ---- ----------------- + appService-test01/slot01/slottriggeredjob-03/202201040202032401 webjob-rg-test +``` + +This command get triggered web job's history for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoryInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityHistory +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Id +History ID. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentitySite, GetViaIdentityTriggeredwebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentitySite, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API uses the production slot. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityHistory, GetViaIdentitySite, GetViaIdentityTriggeredwebjob, List +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggeredwebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityTriggeredwebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredJobHistory + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotWebJob.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotWebJob.md new file mode 100644 index 000000000000..4b71056f272f --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzWebAppSlotWebJob.md @@ -0,0 +1,134 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslotwebjob +schema: 2.0.0 +--- + +# Get-AzWebAppSlotWebJob + +## SYNOPSIS +List webjobs for a deployment slot. + +## SYNTAX + +``` +Get-AzWebAppSlotWebJob -AppName -ResourceGroupName -SlotName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +List webjobs for a deployment slot. + +## EXAMPLES + +### Example 1: List webjobs for a deployment slot +```powershell +Get-AzWebAppSlotWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slottriggeredjob-03 webjob-rg-test +appService-test01/slot01/slottriggeredjob-04 webjob-rg-test +appService-test01/slot01/slotcontinuousjob-03 webjob-rg-test +appService-test01/slot01/slotcontinuousjob-04 webjob-rg-test +``` + +This command lists webjobs for a deployment slot. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API returns deployments for the production slot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJob.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJob.md new file mode 100644 index 000000000000..8a03a475f464 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJob.md @@ -0,0 +1,209 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebapptriggeredwebjob +schema: 2.0.0 +--- + +# Get-AzWebAppTriggeredWebJob + +## SYNOPSIS +Get or list triggered web for an app. + +## SYNTAX + +### List (Default) +``` +Get-AzWebAppTriggeredWebJob -AppName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzWebAppTriggeredWebJob -AppName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzWebAppTriggeredWebJob -InputObject [-DefaultProfile ] [] +``` + +### GetViaIdentitySite +``` +Get-AzWebAppTriggeredWebJob -Name -SiteInputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get or list triggered web for an app. + +## EXAMPLES + +### Example 1: List triggered webs for an app +```powershell +Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/triggeredjob-01 webjob-rg-test +appService-test01/triggeredjob-02 webjob-rg-test +``` + +This command lists triggered webs for an app. + +### Example 2: Get triggered web for an app +```powershell +Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/triggeredjob-01 webjob-rg-test +``` + +This command gets triggered web for an app. + +### Example 3: Get triggered web for an app by pipeline +```powershell +$webjob = Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 +Start-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 +$webjob.Id | Get-AzWebAppTriggeredWebJob +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/triggeredjob-01 webjob-rg-test +``` + +This command gets triggered web for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredWebJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJobHistory.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJobHistory.md new file mode 100644 index 000000000000..d9a8ccbb7e11 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzWebAppTriggeredWebJobHistory.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebapptriggeredwebjobhistory +schema: 2.0.0 +--- + +# Get-AzWebAppTriggeredWebJobHistory + +## SYNOPSIS +Get or list triggered web job's history for an app. + +## SYNTAX + +### List (Default) +``` +Get-AzWebAppTriggeredWebJobHistory -AppName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzWebAppTriggeredWebJobHistory -AppName -Id -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzWebAppTriggeredWebJobHistory -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentitySite +``` +Get-AzWebAppTriggeredWebJobHistory -Id -Name -SiteInputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityTriggeredwebjob +``` +Get-AzWebAppTriggeredWebJobHistory -Id -TriggeredwebjobInputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get or list triggered web job's history for an app. + +## EXAMPLES + +### Example 1: List triggered web job's history for an app +```powershell +Get-AzWebAppTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 +``` + +```output +Kind Name ResourceGroupName +---- ---- ----------------- + appService-test01/triggeredjob-01/202201040249386155 webjob-rg-test + appService-test01/triggeredjob-01/202201040236300466 webjob-rg-test +``` + +This command lists triggered web job's history for an app. + +### Example 2: Get triggered web job's history for an app +```powershell +Get-AzWebAppTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 -Id 202201040236300466 +``` + +```output +Kind Name ResourceGroupName +---- ---- ----------------- + appService-test01/triggeredjob-01/202201040236300466 webjob-rg-test +``` + +This command get triggered web job's history for an app. + +### Example 3: Get triggered web job's history for an app by pipeline +```powershell +$logs = Get-AzWebAppTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 +$logs[0].Id | Get-AzWebAppTriggeredWebJobHistory +``` + +```output +Kind Name ResourceGroupName +---- ---- ----------------- + appService-test01/triggeredjob-01/202201040236300466 webjob-rg-test +``` + +This command get triggered web job's history for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +History ID. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentitySite, GetViaIdentityTriggeredwebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentitySite, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggeredwebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityTriggeredwebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredJobHistory + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Get-AzWebAppWebJob.md b/src/Websites/Websites.Autorest/docs/Get-AzWebAppWebJob.md new file mode 100644 index 000000000000..1b1e45ad84fa --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Get-AzWebAppWebJob.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappwebjob +schema: 2.0.0 +--- + +# Get-AzWebAppWebJob + +## SYNOPSIS +List webjobs for an app. + +## SYNTAX + +``` +Get-AzWebAppWebJob -AppName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +List webjobs for an app. + +## EXAMPLES + +### Example 1: List webjobs for an app +```powershell +Get-AzWebAppWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 +``` + +```output +Name Kind WebJobType +---- ---- ---------- +appService-test01/triggeredjob-01 +appService-test01/triggeredjob-02 +appService-test01/continuousjob-01 +appService-test01/continuousjob-02 +``` + +This command lists webjobs for an app. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebApp.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebApp.md new file mode 100644 index 000000000000..b8d27c824720 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebApp.md @@ -0,0 +1,806 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebapp +schema: 2.0.0 +--- + +# New-AzStaticWebApp + +## SYNOPSIS +Description for create a new static site in an existing resource group, or create an existing static site. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStaticWebApp -Name -ResourceGroupName -Location [-SubscriptionId ] + [-AllowConfigFileUpdate] [-ApiBuildCommand ] [-ApiLocation ] [-AppArtifactLocation ] + [-AppBuildCommand ] [-AppLocation ] [-Branch ] [-Capacity ] + [-EnableSystemAssignedIdentity] [-ForkRepositoryDescription ] [-ForkRepositoryIsPrivate] + [-ForkRepositoryName ] [-ForkRepositoryOwner ] [-GithubActionSecretNameOverride ] + [-Kind ] [-OutputLocation ] [-RepositoryToken ] [-RepositoryUrl ] + [-SkipGithubActionWorkflowGeneration] [-SkuCapability ] [-SkuCapacityDefault ] + [-SkuCapacityElasticMaximum ] [-SkuCapacityMaximum ] [-SkuCapacityMinimum ] + [-SkuCapacityScaleType ] [-SkuFamily ] [-SkuLocation ] [-SkuName ] + [-SkuSize ] [-SkuTier ] [-StagingEnvironmentPolicy ] [-Tag ] + [-TemplateRepositoryUrl ] [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebApp -InputObject -Location [-AllowConfigFileUpdate] + [-ApiBuildCommand ] [-ApiLocation ] [-AppArtifactLocation ] + [-AppBuildCommand ] [-AppLocation ] [-Branch ] [-Capacity ] + [-EnableSystemAssignedIdentity] [-ForkRepositoryDescription ] [-ForkRepositoryIsPrivate] + [-ForkRepositoryName ] [-ForkRepositoryOwner ] [-GithubActionSecretNameOverride ] + [-Kind ] [-OutputLocation ] [-RepositoryToken ] [-RepositoryUrl ] + [-SkipGithubActionWorkflowGeneration] [-SkuCapability ] [-SkuCapacityDefault ] + [-SkuCapacityElasticMaximum ] [-SkuCapacityMaximum ] [-SkuCapacityMinimum ] + [-SkuCapacityScaleType ] [-SkuFamily ] [-SkuLocation ] [-SkuName ] + [-SkuSize ] [-SkuTier ] [-StagingEnvironmentPolicy ] [-Tag ] + [-TemplateRepositoryUrl ] [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebApp -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzStaticWebApp -Name -ResourceGroupName -JsonString [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for create a new static site in an existing resource group, or create an existing static site. + +## EXAMPLES + +### Example 1: Create a new static site in an existing resource group, or updates an existing static site +```powershell +New-AzStaticWebApp -ResourceGroupName 'azure-rg-test' -Name 'staticweb-45asde' -Location 'Central US' -RepositoryUrl 'https://github.com/LucasYao93/blazor-starter' -RepositoryToken 'githubAccessToken' -Branch 'branch02' -AppLocation 'Client' -ApiLocation 'Api' -OutputLocation 'wwwroot' -SkuName 'Standard' +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb-45asde Microsoft.Web/staticSites +``` + +This command creates a new static site in an existing resource group, or updates an existing static site. + +### Example 2: Create a new static site in an existing resource group through specified template repository +```powershell +New-AzStaticWebApp -ResourceGroupName 'azure-rg-test' -Name staticweb-pwsh01 -Location "Central US" -RepositoryToken 'xxxxxxxxxxxxxxxxx' -TemplateRepositoryUrl 'https://github.com/staticwebdev/blazor-starter' -ForkRepositoryDescription "Test template repository function of the azure static web." -ForkRepositoryName "test-blazor-starter" -ForkRepositoryOwner 'LucasYao93' -Branch 'main' -AppLocation 'Client' -ApiLocation 'Api' -OutputLocation 'wwwroot' -SkuName 'Standard' +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb-pwsh01 Microsoft.Web/staticSites +``` + +This command creates a new static site in an existing resource group, or updates an existing static site through specified template repository. + +## PARAMETERS + +### -AllowConfigFileUpdate +\false\ if config file is locked for this static web app; otherwise, \true\. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiBuildCommand +A custom command to run during deployment of the Azure Functions API application. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiLocation +The path to the api code within the repository. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppArtifactLocation +Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppBuildCommand +A custom command to run during deployment of the static content application. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppLocation +The path to the app code within the repository. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Branch +The target branch in the repository. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Capacity +Current number of instances assigned to the resource. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryDescription +Description of the newly generated repository. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryIsPrivate +Whether or not the newly generated repository is a private repository. +Defaults to false (i.e. +public). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryName +Name of the newly generated repository. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryOwner +Owner of the newly generated repository. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GithubActionSecretNameOverride +Github Action secret name override. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource Location. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site to create or update. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputLocation +The output path of the app after building. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryToken +A user's github repository token. +This is used to setup the Github Actions workflow file and API secrets. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryUrl +URL for the repository of the static site. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipGithubActionWorkflowGeneration +Skip Github Action workflow generation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapability +Capabilities of the SKU, e.g., is traffic manager enabled? + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ICapability[] +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacityDefault +Default number of workers for this App Service plan SKU. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacityElasticMaximum +Maximum number of Elastic workers for this App Service plan SKU. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacityMaximum +Maximum number of workers for this App Service plan SKU. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacityMinimum +Minimum number of workers for this App Service plan SKU. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacityScaleType +Available scale configurations for an App Service plan. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +Family code of the resource SKU. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuLocation +Locations of the SKU. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name of the resource SKU. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +Size specifier of the resource SKU. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +Service tier of the resource SKU. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StagingEnvironmentPolicy +State indicating whether staging environments are allowed or not allowed for a static web app. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +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). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateRepositoryUrl +URL of the template repository. +The newly generated repository will be based on this one. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteArmResource + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md new file mode 100644 index 000000000000..277be770c32d --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md @@ -0,0 +1,295 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappbuildappsetting +schema: 2.0.0 +--- + +# New-AzStaticWebAppBuildAppSetting + +## SYNOPSIS +Description for create the app settings of a static site build. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStaticWebAppBuildAppSetting -EnvironmentName -Name -ResourceGroupName + [-SubscriptionId ] [-AppSetting ] [-Kind ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppBuildAppSetting -InputObject [-AppSetting ] [-Kind ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityStaticSiteExpanded +``` +New-AzStaticWebAppBuildAppSetting -EnvironmentName -StaticSiteInputObject + [-AppSetting ] [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebAppBuildAppSetting -EnvironmentName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzStaticWebAppBuildAppSetting -EnvironmentName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Description for create the app settings of a static site build. + +## EXAMPLES + +### Example 1: Create or updates the app settings of a static site build +```powershell +New-AzStaticWebAppBuildAppSetting -ResourceGroupName azure-rg-test -Name staticweb-pwsh01 -EnvironmentName 'default' -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/builds/config +``` + +This command creates or updates the app settings of a static site build. + +### Example 2: Create or updates the app settings of a static site build by pipeline +```powershell +Get-AzStaticWebAppBuildAppSetting -ResourceGroupName resourceGroup -Name taticweb00 -EnvironmentName 'default' | New-AzStaticWebAppBuildAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/builds/config +``` + +This command creates or updates the app settings of a static site by pipeline build. + +## PARAMETERS + +### -AppSetting +Settings. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityStaticSiteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md new file mode 100644 index 000000000000..36fce356c969 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md @@ -0,0 +1,295 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappbuildfunctionappsetting +schema: 2.0.0 +--- + +# New-AzStaticWebAppBuildFunctionAppSetting + +## SYNOPSIS +Description for create the function app settings of a static site build. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -Name -ResourceGroupName + [-SubscriptionId ] [-AppSetting ] [-Kind ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppBuildFunctionAppSetting -InputObject [-AppSetting ] + [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityStaticSiteExpanded +``` +New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -StaticSiteInputObject + [-AppSetting ] [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Description for create the function app settings of a static site build. + +## EXAMPLES + +### Example 1: Create or updates the app settings of a static site build +```powershell +New-AzStaticWebAppBuildFunctionAppSetting -ResourceGroupName azure-rg-test -Name staticweb-pwsh01 -EnvironmentName 'default' -AppSetting @{'functionapp01' = 'value01'; 'functionapp02' = 'value02' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/builds/config +``` + +This command creates or updates the app settings of a static site build. + +### Example 2: Create or updates the app settings of a static site build by pipeline +```powershell +Get-AzStaticWebAppBuildFunctionAppSetting -ResourceGroupName resourceGroup -Name staticweb01 -EnvironmentName 'default' | New-AzStaticWebAppBuildFunctionAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/builds/config +``` + +This command creates or updates the app settings of a static site build by pipeline. + +## PARAMETERS + +### -AppSetting +Settings. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityStaticSiteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppCustomDomain.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppCustomDomain.md new file mode 100644 index 000000000000..1d638b03b059 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppCustomDomain.md @@ -0,0 +1,313 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappcustomdomain +schema: 2.0.0 +--- + +# New-AzStaticWebAppCustomDomain + +## SYNOPSIS +Description for create a new static site custom domain in an existing resource group and static site. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + [-SubscriptionId ] [-Kind ] [-ValidationMethod ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppCustomDomain -InputObject [-Kind ] [-ValidationMethod ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityStaticSiteExpanded +``` +New-AzStaticWebAppCustomDomain -DomainName -StaticSiteInputObject + [-Kind ] [-ValidationMethod ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Description for create a new static site custom domain in an existing resource group and static site. + +## EXAMPLES + +### Example 1: Create a new static site custom domain in an existing resource group and static site +```powershell +New-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName 'www01.azpstest.net' +``` + +```output +Kind Name Type +---- ---- ---- + www01.azpstest.net Microsoft.Web/staticSites/customDomains +``` + +This command creates a new static site custom domain in an existing resource group and static site. +First, Need to [configure dns provider](https://learn.microsoft.com/en-us/azure/static-web-apps/custom-domain#configure-dns-provider) for static site. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +The custom domain to create. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityStaticSiteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationMethod +Validation method for adding a custom domain + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteCustomDomainOverviewArmResource + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md new file mode 100644 index 000000000000..b5a21e3f32e9 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md @@ -0,0 +1,256 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappfunctionappsetting +schema: 2.0.0 +--- + +# New-AzStaticWebAppFunctionAppSetting + +## SYNOPSIS +Description for create the function app settings of a static site. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-SubscriptionId ] + [-AppSetting ] [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppFunctionAppSetting -InputObject [-AppSetting ] + [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for create the function app settings of a static site. + +## EXAMPLES + +### Example 1: Create or updates the function app settings of a static site +```powershell +New-AzStaticWebAppFunctionAppSetting -ResourceGroupName azure-rg-test -Name staticweb-pwsh01 -AppSetting @{'function01' = 'value01'; 'function02' = 'value02' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/config +``` + +This command creates or updates the function app settings of a static site. + +### Example 2: Create or updates the function app settings of a static site by pipeline +```powershell +Get-AzStaticWebAppFunctionAppSetting -ResourceGroupName resourceGroup -Name staticweb01 | New-AzStaticWebAppFunctionAppSetting -AppSetting @{'function01' = 'value01'; 'function02' = 'value02' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/config +``` + +This command creates or updates the function app settings of a static site by pipeline. + +## PARAMETERS + +### -AppSetting +Settings. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +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). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md new file mode 100644 index 000000000000..f0bab285488d --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md @@ -0,0 +1,256 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappsetting +schema: 2.0.0 +--- + +# New-AzStaticWebAppSetting + +## SYNOPSIS +Description for create the app settings of a static site. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStaticWebAppSetting -Name -ResourceGroupName [-SubscriptionId ] + [-AppSetting ] [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppSetting -InputObject [-AppSetting ] [-Kind ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebAppSetting -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzStaticWebAppSetting -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for create the app settings of a static site. + +## EXAMPLES + +### Example 1: Create or updates the app settings of a static site +```powershell +New-AzStaticWebAppSetting -ResourceGroupName resourceGroup -Name staticweb01 -AppSetting @{'function01' = 'value01'; 'function02' = 'value02' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/config +``` + +This command creates or updates the app settings of a static site. + +### Example 2: Create or updates the app settings of a static site by pipeline. +```powershell +Get-AzStaticWebAppSetting -ResourceGroupName resourceGroup -Name staticweb01 | New-AzStaticWebAppSetting -AppSetting @{'function01' = 'value01'; 'function02' = 'value02' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/config +``` + +This command creates or updates the app settings of a static site by pipeline. + +## PARAMETERS + +### -AppSetting +Settings. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +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). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md new file mode 100644 index 000000000000..8587753feb44 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md @@ -0,0 +1,313 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappuserroleinvitationlink +schema: 2.0.0 +--- + +# New-AzStaticWebAppUserRoleInvitationLink + +## SYNOPSIS +Description for create an invitation link for a user with the role + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName [-SubscriptionId ] + [-Domain ] [-Kind ] [-NumHoursToExpiration ] [-Provider ] [-Role ] + [-UserDetail ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppUserRoleInvitationLink -InputObject [-Domain ] [-Kind ] + [-NumHoursToExpiration ] [-Provider ] [-Role ] [-UserDetail ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for create an invitation link for a user with the role + +## EXAMPLES + +### Example 1: Create an invitation link for a user with the role +```powershell +New-AzStaticWebAppUserRoleInvitationLink -ResourceGroupName azure-rg-test -Name staticweb-pwsh02 -Domain 'xxxxxxxxx.azurestaticapps.net' -Provider 'github' -UserDetail 'UserName' -Role 'reader' -NumHoursToExpiration 1 +``` + +```output +Kind Name Type +---- ---- ---- + 078284a9-ce47-4aa5-b54c-2e55a67dd53c Microsoft.Web/staticSites/invitations +``` + +This command creates an invitation link for a user with the role. + +### Example 2: Create an invitation link for a user with the role by pipeline +```powershell +$web = Get-AzStaticWebApp -ResourceGroupName resourceGroup -Name staticweb00 +New-AzStaticWebAppUserRoleInvitationLink -InputObject $web -Domain 'Hostname' -Provider 'github' -UserDetail 'UserName' -Role 'admin,contributor' -NumHoursToExpiration 1 + +``` + +This command creates an invitation link for a user with the role by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The domain name for the static site custom domain. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumHoursToExpiration +The number of hours the sas token stays valid + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Provider +The identity provider for the static site user. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The roles for the static site user, in free-form string format + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +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). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserDetail +The user id for the static site user. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserInvitationResponseResource + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Register-AzStaticWebAppUserProvidedFunctionApp.md b/src/Websites/Websites.Autorest/docs/Register-AzStaticWebAppUserProvidedFunctionApp.md new file mode 100644 index 000000000000..357fb4bb927b --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Register-AzStaticWebAppUserProvidedFunctionApp.md @@ -0,0 +1,290 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/register-azstaticwebappuserprovidedfunctionapp +schema: 2.0.0 +--- + +# Register-AzStaticWebAppUserProvidedFunctionApp + +## SYNOPSIS +Description for Register a user provided function app with a static site build + +## SYNTAX + +### RegisterViaJsonFilePath1 (Default) +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name + -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-Forced] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### RegisterViaJsonFilePath +``` +Register-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -FunctionAppName + -Name -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-Forced] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### RegisterViaJsonString +``` +Register-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -FunctionAppName + -Name -ResourceGroupName -JsonString [-SubscriptionId ] [-Forced] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### RegisterViaJsonString1 +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name + -ResourceGroupName -JsonString [-SubscriptionId ] [-Forced] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## 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 +```powershell +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' +``` + +```output +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 +```powershell +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 +``` + +```output +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 + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: RegisterViaJsonFilePath, RegisterViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Forced +Specify \true\ 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 \false\. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Register operation + +```yaml +Type: System.String +Parameter Sets: RegisterViaJsonFilePath, RegisterViaJsonFilePath1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Register operation + +```yaml +Type: System.String +Parameter Sets: RegisterViaJsonString, RegisterViaJsonString1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionAppArmResource + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebApp.md b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebApp.md new file mode 100644 index 000000000000..dc7e32843ad8 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebApp.md @@ -0,0 +1,218 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebapp +schema: 2.0.0 +--- + +# Remove-AzStaticWebApp + +## SYNOPSIS +Description for Deletes a static site. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStaticWebApp -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzStaticWebApp -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Deletes a static site. + +## EXAMPLES + +### Example 1: Delete a static site +```powershell +Remove-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb01 + +``` + +This command deletes a static site. + +### Example 2: Delete a static site by pipeline +```powershell +Get-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb02 | Remove-AzStaticWebApp + +``` + +This command deletes a static site by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site to delete. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +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). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppAttachedRepository.md b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppAttachedRepository.md new file mode 100644 index 000000000000..2f31bb8fbacb --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppAttachedRepository.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebappattachedrepository +schema: 2.0.0 +--- + +# Remove-AzStaticWebAppAttachedRepository + +## SYNOPSIS +Description for Detaches a static site. + +## SYNTAX + +### Detach (Default) +``` +Remove-AzStaticWebAppAttachedRepository -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DetachViaIdentity +``` +Remove-AzStaticWebAppAttachedRepository -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Detaches a static site. + +## EXAMPLES + +### Example 1: Remove repository of static site +```powershell +Remove-AzStaticWebAppAttachedRepository -ResourceGroupName azure-rg-test -Name staticweb-portal01 + +``` + +This command removes repository of static site. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DetachViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site to detach. + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: True +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). + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppBuild.md b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppBuild.md new file mode 100644 index 000000000000..947054372401 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppBuild.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebappbuild +schema: 2.0.0 +--- + +# Remove-AzStaticWebAppBuild + +## SYNOPSIS +Description for Deletes a static site build. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStaticWebAppBuild -EnvironmentName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzStaticWebAppBuild -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityStaticSite +``` +Remove-AzStaticWebAppBuild -EnvironmentName -StaticSiteInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Deletes a static site build. + +## EXAMPLES + +### Example 1: Delete a static site build +```powershell +Remove-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal01 -EnvironmentName '2' + +``` + +This command deletes a static site build. + +### Example 2: Delete a static site build by pipeline +```powershell +Get-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal01 -EnvironmentName '3' | Remove-AzStaticWebAppBuild + +``` + +This command deletes a static site build by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppCustomDomain.md b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppCustomDomain.md new file mode 100644 index 000000000000..e446e7e50b88 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppCustomDomain.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebappcustomdomain +schema: 2.0.0 +--- + +# Remove-AzStaticWebAppCustomDomain + +## SYNOPSIS +Description for Deletes a custom domain. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzStaticWebAppCustomDomain -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityStaticSite +``` +Remove-AzStaticWebAppCustomDomain -DomainName -StaticSiteInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Deletes a custom domain. + +## EXAMPLES + +### Example 1: Delete a custom domain +```powershell +Remove-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName domainName + +``` + +This command deletes a custom domain. + +### Example 2: Delete a custom domain by pipeline +```powershell +Get-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName domainName | Remove-AzStaticWebAppCustomDomain + +``` + +This command deletes a custom domain by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +The custom domain to delete. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppUser.md b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppUser.md new file mode 100644 index 000000000000..f79f2e563a1d --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Remove-AzStaticWebAppUser.md @@ -0,0 +1,261 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebappuser +schema: 2.0.0 +--- + +# Remove-AzStaticWebAppUser + +## SYNOPSIS +Description for Deletes the user entry from the static site. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStaticWebAppUser -AuthProvider -Name -ResourceGroupName -UserId + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzStaticWebAppUser -InputObject [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### DeleteViaIdentityAuthprovider +``` +Remove-AzStaticWebAppUser -AuthproviderInputObject -UserId + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityStaticSite +``` +Remove-AzStaticWebAppUser -AuthProvider -StaticSiteInputObject -UserId + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Deletes the user entry from the static site. + +## EXAMPLES + +### Example 1: Delete a user entry from the static site +```powershell +Remove-AzStaticWebAppUser -ResourceGroupName resourceGroup -Name staticweb01 -Authprovider 'all' -UserId 'xxxxxxxx' + +``` + +This command deletes the user entry from the static site. + +### Example 2: Delete all users from the static site +```powershell +$userList = Get-AzStaticWebAppUser -ResourceGroupName resourceGroup -Name staticweb01 -Authprovider all +Remove-AzStaticWebAppUser -InputObject $userList + +``` + +This command deletes all users from the static site. + +## PARAMETERS + +### -AuthProvider +The auth provider for this user. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthproviderInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentityAuthprovider +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the staticsite. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +The user id of the user. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityAuthprovider, DeleteViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzWebAppContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Remove-AzWebAppContinuousWebJob.md new file mode 100644 index 000000000000..8b8af098d0be --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Remove-AzWebAppContinuousWebJob.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebappcontinuouswebjob +schema: 2.0.0 +--- + +# Remove-AzWebAppContinuousWebJob + +## SYNOPSIS +Delete a continuous web job for an app. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWebAppContinuousWebJob -AppName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzWebAppContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentitySite +``` +Remove-AzWebAppContinuousWebJob -Name -SiteInputObject + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a continuous web job for an app. + +## EXAMPLES + +### Example 1: Delete a continuous web job for an app +```powershell +Remove-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 + +``` + +This command deletes a continuous web job for an app. + +### Example 2: Delete a continuous web job for an app by pipeline +```powershell +Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-02 | Remove-AzWebAppContinuousWebJob + +``` + +This command deletes a continuous web job for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotContinuousWebJob.md new file mode 100644 index 000000000000..7c664357b32a --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotContinuousWebJob.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebappslotcontinuouswebjob +schema: 2.0.0 +--- + +# Remove-AzWebAppSlotContinuousWebJob + +## SYNOPSIS +Delete a continuous web job for a deployment slot. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWebAppSlotContinuousWebJob -AppName -Name -ResourceGroupName + -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzWebAppSlotContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityContinuouswebjob +``` +Remove-AzWebAppSlotContinuousWebJob -ContinuouswebjobInputObject -SlotName + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentitySite +``` +Remove-AzWebAppSlotContinuousWebJob -Name -SiteInputObject -SlotName + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a continuous web job for a deployment slot. + +## EXAMPLES + +### Example 1: Delete a continuous web job for a deployment slot +```powershell +Remove-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-03 + +``` + +This command deletes a continuous web job for a deployment slot. + +### Example 2: Delete a continuous web job for a deployment slot by pipeline +```powershell +Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-04 | Remove-AzWebAppSlotContinuousWebJob + +``` + +This command deletes a continuous web job for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinuouswebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentityContinuouswebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API deletes a deployment for the production slot. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityContinuouswebjob, DeleteViaIdentitySite +Aliases: + +Required: True +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). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotTriggeredWebJob.md b/src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotTriggeredWebJob.md new file mode 100644 index 000000000000..6d49a5e24c3c --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Remove-AzWebAppSlotTriggeredWebJob.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebappslottriggeredwebjob +schema: 2.0.0 +--- + +# Remove-AzWebAppSlotTriggeredWebJob + +## SYNOPSIS +Delete a triggered web job for a deployment slot. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWebAppSlotTriggeredWebJob -AppName -Name -ResourceGroupName + -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzWebAppSlotTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentitySite +``` +Remove-AzWebAppSlotTriggeredWebJob -Name -SiteInputObject -SlotName + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityTriggeredwebjob +``` +Remove-AzWebAppSlotTriggeredWebJob -SlotName -TriggeredwebjobInputObject + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a triggered web job for a deployment slot. + +## EXAMPLES + +### Example 1: Delete a triggered web job for a deployment slot +```powershell +Remove-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 + +``` + +This command deletes a triggered web job for a deployment slot. + +### Example 2: Delete a triggered web job for a deployment slot by pipeline +```powershell +Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-04 | Remove-AzWebAppSlotTriggeredWebJob + +``` + +This command deletes a triggered web job for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API deletes web job for the production slot. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentitySite, DeleteViaIdentityTriggeredwebjob +Aliases: + +Required: True +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). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggeredwebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentityTriggeredwebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Remove-AzWebAppTriggeredWebJob.md b/src/Websites/Websites.Autorest/docs/Remove-AzWebAppTriggeredWebJob.md new file mode 100644 index 000000000000..d0d2cc8214bb --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Remove-AzWebAppTriggeredWebJob.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebapptriggeredwebjob +schema: 2.0.0 +--- + +# Remove-AzWebAppTriggeredWebJob + +## SYNOPSIS +Delete a triggered web job for an app. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWebAppTriggeredWebJob -AppName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzWebAppTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentitySite +``` +Remove-AzWebAppTriggeredWebJob -Name -SiteInputObject + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a triggered web job for an app. + +## EXAMPLES + +### Example 1: Delete a triggered web job for an app +```powershell +Remove-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 + +``` + +This command deletes a triggered web job for an app. + +### Example 2: Delete a triggered web job for an app by pipeline +```powershell +Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-02 | Remove-AzWebAppTriggeredWebJob + +``` + +This command deletes a triggered web job for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Reset-AzStaticWebAppApiKey.md b/src/Websites/Websites.Autorest/docs/Reset-AzStaticWebAppApiKey.md new file mode 100644 index 000000000000..cea9cfd5f514 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Reset-AzStaticWebAppApiKey.md @@ -0,0 +1,276 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/reset-azstaticwebappapikey +schema: 2.0.0 +--- + +# Reset-AzStaticWebAppApiKey + +## SYNOPSIS +Description for Resets the api key for an existing static site. + +## SYNTAX + +### ResetExpanded (Default) +``` +Reset-AzStaticWebAppApiKey -Name -ResourceGroupName [-SubscriptionId ] + [-Kind ] [-RepositoryToken ] [-ShouldUpdateRepository] [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ResetViaIdentityExpanded +``` +Reset-AzStaticWebAppApiKey -InputObject [-Kind ] [-RepositoryToken ] + [-ShouldUpdateRepository] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ResetViaJsonFilePath +``` +Reset-AzStaticWebAppApiKey -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ResetViaJsonString +``` +Reset-AzStaticWebAppApiKey -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Resets the api key for an existing static site. + +## EXAMPLES + +### Example 1: Reset the api key for an existing static site. +```powershell +Reset-AzStaticWebAppApiKey -ResourceGroupName azure-rg-test -Name staticweb-portal01 + +``` + +This command resets the api key for an existing static site. + +### Example 2: Reset the api key for an existing static site by pipeline +```powershell +Get-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb-portal01 | Reset-AzStaticWebAppApiKey + +``` + +This command resets the api key for an existing static site by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: ResetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Reset operation + +```yaml +Type: System.String +Parameter Sets: ResetViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Reset operation + +```yaml +Type: System.String +Parameter Sets: ResetViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: ResetExpanded, ResetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: ResetExpanded, ResetViaJsonFilePath, ResetViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryToken +The token which proves admin privileges to the repository. + +```yaml +Type: System.String +Parameter Sets: ResetExpanded, ResetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: ResetExpanded, ResetViaJsonFilePath, ResetViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShouldUpdateRepository +Determines whether the repository should be updated with the new properties. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ResetExpanded, ResetViaIdentityExpanded +Aliases: + +Required: False +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). + +```yaml +Type: System.String +Parameter Sets: ResetExpanded, ResetViaJsonFilePath, ResetViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Start-AzWebAppContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Start-AzWebAppContinuousWebJob.md new file mode 100644 index 000000000000..641b274521a7 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Start-AzWebAppContinuousWebJob.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebappcontinuouswebjob +schema: 2.0.0 +--- + +# Start-AzWebAppContinuousWebJob + +## SYNOPSIS +Start a continuous web job for an app. + +## SYNTAX + +### Start (Default) +``` +Start-AzWebAppContinuousWebJob -AppName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StartViaIdentity +``` +Start-AzWebAppContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### StartViaIdentitySite +``` +Start-AzWebAppContinuousWebJob -Name -SiteInputObject + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Start a continuous web job for an app. + +## EXAMPLES + +### Example 1: Start a continuous web job for an app +```powershell +Start-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 + +``` + +This command starts a continuous web job for an app. + +### Example 2: Start a continuous web job for an app by pipeline +```powershell +Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 | Start-AzWebAppContinuousWebJob + +``` + +This command starts a continuous web job for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Start, StartViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StartViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotContinuousWebJob.md new file mode 100644 index 000000000000..11c23a104ee2 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotContinuousWebJob.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebappslotcontinuouswebjob +schema: 2.0.0 +--- + +# Start-AzWebAppSlotContinuousWebJob + +## SYNOPSIS +Start a continuous web job for a deployment slot. + +## SYNTAX + +### Start (Default) +``` +Start-AzWebAppSlotContinuousWebJob -AppName -Name -ResourceGroupName + -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### StartViaIdentity +``` +Start-AzWebAppSlotContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### StartViaIdentityContinuouswebjob +``` +Start-AzWebAppSlotContinuousWebJob -ContinuouswebjobInputObject -SlotName + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StartViaIdentitySite +``` +Start-AzWebAppSlotContinuousWebJob -Name -SiteInputObject -SlotName + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Start a continuous web job for a deployment slot. + +## EXAMPLES + +### Example 1: Start a continuous web job for a deployment slot +```powershell +Start-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-01 + +``` + +This command starts a continuous web job for an app. + +### Example 2: Start a continuous web job for a deployment slot by pipeline +```powershell +Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-01 | Start-AzWebAppSlotContinuousWebJob + +``` + +This command starts a continuous web job for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinuouswebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StartViaIdentityContinuouswebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Start, StartViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StartViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API deletes a deployment for the production slot. + +```yaml +Type: System.String +Parameter Sets: Start, StartViaIdentityContinuouswebjob, StartViaIdentitySite +Aliases: + +Required: True +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). + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotTriggeredWebJob.md b/src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotTriggeredWebJob.md new file mode 100644 index 000000000000..b044de7d2c60 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Start-AzWebAppSlotTriggeredWebJob.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebappslottriggeredwebjob +schema: 2.0.0 +--- + +# Start-AzWebAppSlotTriggeredWebJob + +## SYNOPSIS +Run a triggered web job for a deployment slot. + +## SYNTAX + +### Run (Default) +``` +Start-AzWebAppSlotTriggeredWebJob -AppName -Name -ResourceGroupName + -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### RunViaIdentity +``` +Start-AzWebAppSlotTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### RunViaIdentitySite +``` +Start-AzWebAppSlotTriggeredWebJob -Name -SiteInputObject -SlotName + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### RunViaIdentityTriggeredwebjob +``` +Start-AzWebAppSlotTriggeredWebJob -SlotName -TriggeredwebjobInputObject + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Run a triggered web job for a deployment slot. + +## EXAMPLES + +### Example 1: Run a triggered web job for a deployment slot +```powershell +Start-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 + +``` + +This command runs a triggered web job for a deployment slot. + +### Example 2: Run a triggered web job for a deployment slot by pipeline +```powershell +Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 | Start-AzWebAppSlotTriggeredWebJob + +``` + +This command runs a triggered web job for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RunViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Run, RunViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RunViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API uses the production slot. + +```yaml +Type: System.String +Parameter Sets: Run, RunViaIdentitySite, RunViaIdentityTriggeredwebjob +Aliases: + +Required: True +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). + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggeredwebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RunViaIdentityTriggeredwebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Start-AzWebAppTriggeredWebJob.md b/src/Websites/Websites.Autorest/docs/Start-AzWebAppTriggeredWebJob.md new file mode 100644 index 000000000000..d2357b7b53d7 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Start-AzWebAppTriggeredWebJob.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebapptriggeredwebjob +schema: 2.0.0 +--- + +# Start-AzWebAppTriggeredWebJob + +## SYNOPSIS +Run a triggered web job for an app. + +## SYNTAX + +### Run (Default) +``` +Start-AzWebAppTriggeredWebJob -AppName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### RunViaIdentity +``` +Start-AzWebAppTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### RunViaIdentitySite +``` +Start-AzWebAppTriggeredWebJob -Name -SiteInputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Run a triggered web job for an app. + +## EXAMPLES + +### Example 1: Run a triggered web job for an app +```powershell +Start-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 + +``` + +This command runs a triggered web job for an app. + +### Example 2: Run a triggered web job for an app by pipeline +```powershell +Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 | Start-AzWebAppTriggeredWebJob + +``` + +This command runs a triggered web job for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RunViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Run, RunViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RunViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Stop-AzWebAppContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Stop-AzWebAppContinuousWebJob.md new file mode 100644 index 000000000000..7fd796c40a1b --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Stop-AzWebAppContinuousWebJob.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/stop-azwebappcontinuouswebjob +schema: 2.0.0 +--- + +# Stop-AzWebAppContinuousWebJob + +## SYNOPSIS +Stop a continuous web job for an app. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzWebAppContinuousWebJob -AppName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StopViaIdentity +``` +Stop-AzWebAppContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### StopViaIdentitySite +``` +Stop-AzWebAppContinuousWebJob -Name -SiteInputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Stop a continuous web job for an app. + +## EXAMPLES + +### Example 1: Stop a continuous web job for an app +```powershell +Stop-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 + +``` + +This command stops a continuous web job for an app. + +### Example 2: Stop a continuous web job for an app by pipeline +```powershell +Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 | Stop-AzWebAppContinuousWebJob + +``` + +This command stops a continuous web job for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Stop, StopViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StopViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Stop-AzWebAppSlotContinuousWebJob.md b/src/Websites/Websites.Autorest/docs/Stop-AzWebAppSlotContinuousWebJob.md new file mode 100644 index 000000000000..0c5913221454 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Stop-AzWebAppSlotContinuousWebJob.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/stop-azwebappslotcontinuouswebjob +schema: 2.0.0 +--- + +# Stop-AzWebAppSlotContinuousWebJob + +## SYNOPSIS +Stop a continuous web job for a deployment slot. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzWebAppSlotContinuousWebJob -AppName -Name -ResourceGroupName + -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### StopViaIdentity +``` +Stop-AzWebAppSlotContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### StopViaIdentityContinuouswebjob +``` +Stop-AzWebAppSlotContinuousWebJob -ContinuouswebjobInputObject -SlotName + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StopViaIdentitySite +``` +Stop-AzWebAppSlotContinuousWebJob -Name -SiteInputObject -SlotName + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Stop a continuous web job for a deployment slot. + +## EXAMPLES + +### Example 1: Stop a continuous web job for a deployment slot +```powershell +Stop-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-01 + +``` + +This command stops a continuous web job for an app. + +### Example 2: Stop a continuous web job for a deployment slot by pipeline +```powershell +Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-01 | Stop-AzWebAppSlotContinuousWebJob + +``` + +This command stops a continuous web job for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinuouswebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StopViaIdentityContinuouswebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Stop, StopViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StopViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API deletes a deployment for the production slot. + +```yaml +Type: System.String +Parameter Sets: Stop, StopViaIdentityContinuouswebjob, StopViaIdentitySite +Aliases: + +Required: True +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). + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Test-AzStaticWebAppCustomDomain.md b/src/Websites/Websites.Autorest/docs/Test-AzStaticWebAppCustomDomain.md new file mode 100644 index 000000000000..fbbb16c60e2d --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Test-AzStaticWebAppCustomDomain.md @@ -0,0 +1,369 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/test-azstaticwebappcustomdomain +schema: 2.0.0 +--- + +# Test-AzStaticWebAppCustomDomain + +## SYNOPSIS +Description for Validates a particular custom domain can be added to a static site. + +## SYNTAX + +### ValidateExpanded (Default) +``` +Test-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + [-SubscriptionId ] [-Kind ] [-ValidationMethod ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Validate +``` +Test-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + -StaticSiteCustomDomainRequestPropertiesEnvelope + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### ValidateViaIdentity +``` +Test-AzStaticWebAppCustomDomain -InputObject + -StaticSiteCustomDomainRequestPropertiesEnvelope + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ValidateViaIdentityExpanded +``` +Test-AzStaticWebAppCustomDomain -InputObject [-Kind ] [-ValidationMethod ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ValidateViaIdentityStaticSite +``` +Test-AzStaticWebAppCustomDomain -DomainName -StaticSiteInputObject + -StaticSiteCustomDomainRequestPropertiesEnvelope + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ValidateViaIdentityStaticSiteExpanded +``` +Test-AzStaticWebAppCustomDomain -DomainName -StaticSiteInputObject + [-Kind ] [-ValidationMethod ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### ValidateViaJsonFilePath +``` +Test-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### ValidateViaJsonString +``` +Test-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for Validates a particular custom domain can be added to a static site. + +## EXAMPLES + +### Example 1: Validate a particular custom domain can be added to a static site +```powershell +Test-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName 'www01.azpstest.net' + +``` + +This command validates a particular custom domain can be added to a static site + +### Example 2: Validate a particular custom domain can be added to a static site by pipeline +```powershell +Get-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName 'www01.azpstest.net' | Get-AzStaticWebAppCustomDomain + +``` + +This command validates a particular custom domain can be added to a static site by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +The custom domain to validate. + +```yaml +Type: System.String +Parameter Sets: Validate, ValidateExpanded, ValidateViaIdentityStaticSite, ValidateViaIdentityStaticSiteExpanded, ValidateViaJsonFilePath, ValidateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: ValidateViaIdentity, ValidateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Validate operation + +```yaml +Type: System.String +Parameter Sets: ValidateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Validate operation + +```yaml +Type: System.String +Parameter Sets: ValidateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded, ValidateViaIdentityExpanded, ValidateViaIdentityStaticSiteExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: Validate, ValidateExpanded, ValidateViaJsonFilePath, ValidateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Validate, ValidateExpanded, ValidateViaJsonFilePath, ValidateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticSiteCustomDomainRequestPropertiesEnvelope +Static Site Custom Domain Request Properties ARM resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteCustomDomainRequestPropertiesArmResource +Parameter Sets: Validate, ValidateViaIdentity, ValidateViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: ValidateViaIdentityStaticSite, ValidateViaIdentityStaticSiteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Validate, ValidateExpanded, ValidateViaJsonFilePath, ValidateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationMethod +Validation method for adding a custom domain + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded, ValidateViaIdentityExpanded, ValidateViaIdentityStaticSiteExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteCustomDomainRequestPropertiesArmResource + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md b/src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md new file mode 100644 index 000000000000..c86786110d93 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/unregister-azstaticwebappbuilduserprovidedfunctionapp +schema: 2.0.0 +--- + +# Unregister-AzStaticWebAppBuildUserProvidedFunctionApp + +## SYNOPSIS +Description for Detach the user provided function app from the static site build + +## SYNTAX + +### Detach (Default) +``` +Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -EnvironmentName -FunctionAppName + -Name -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DetachViaIdentity +``` +Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -InputObject + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DetachViaIdentityBuild +``` +Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -BuildInputObject + -FunctionAppName [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DetachViaIdentityStaticSite +``` +Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -EnvironmentName -FunctionAppName + -StaticSiteInputObject [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Description for Detach the user provided function app from the static site build + +## EXAMPLES + +### Example 1: Unregister the user provided function app from the static site build +```powershell +Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' -EnvironmentName 'default' -FunctionAppName 'functionAppName01' + +``` + +This command unregisters the user provided function app from the static site build. + +### Example 2: Unregister the user provided function app from the static site build by pipeline +```powershell +Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' -EnvironmentName 'default' -FunctionAppName 'functionAppName01' -FunctionAppResourceId 'functionAppId01' -FunctionAppRegion 'eastus' -Forced | Unregister-AzStaticWebAppBuildUserProvidedFunctionApp + +``` + +This command unregisters the user provided function app from the static site build by pipeline. + +## PARAMETERS + +### -BuildInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DetachViaIdentityBuild +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: Detach, DetachViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunctionAppName +Name of the function app registered with the static site build. + +```yaml +Type: System.String +Parameter Sets: Detach, DetachViaIdentityBuild, DetachViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DetachViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DetachViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppUserProvidedFunctionApp.md b/src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppUserProvidedFunctionApp.md new file mode 100644 index 000000000000..99c099aaa8a4 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Unregister-AzStaticWebAppUserProvidedFunctionApp.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/unregister-azstaticwebappuserprovidedfunctionapp +schema: 2.0.0 +--- + +# Unregister-AzStaticWebAppUserProvidedFunctionApp + +## SYNOPSIS +Description for Detach the user provided function app from the static site + +## SYNTAX + +### Detach (Default) +``` +Unregister-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### DetachViaIdentity +``` +Unregister-AzStaticWebAppUserProvidedFunctionApp -InputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DetachViaIdentityStaticSite +``` +Unregister-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName + -StaticSiteInputObject [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## 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 +```powershell +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 +```powershell +Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName $env.resourceGroup -Name $env.staticweb00 -FunctionAppName $env.functionAppName01 -FunctionAppResourceId $env.functionAppId01 -FunctionAppRegion $env.location -Forced | Unregister-AzStaticWebAppUserProvidedFunctionApp + +``` + +This command unregisters the user provided function app from the static site by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunctionAppName +Name of the function app registered with the static site. + +```yaml +Type: System.String +Parameter Sets: Detach, DetachViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DetachViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DetachViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Update-AzStaticWebApp.md b/src/Websites/Websites.Autorest/docs/Update-AzStaticWebApp.md new file mode 100644 index 000000000000..8eede366e6c9 --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Update-AzStaticWebApp.md @@ -0,0 +1,525 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/update-azstaticwebapp +schema: 2.0.0 +--- + +# Update-AzStaticWebApp + +## SYNOPSIS +Description for update a new static site in an existing resource group, or update an existing static site. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStaticWebApp -Name -ResourceGroupName [-SubscriptionId ] + [-AllowConfigFileUpdate] [-ApiBuildCommand ] [-ApiLocation ] [-AppArtifactLocation ] + [-AppBuildCommand ] [-AppLocation ] [-Branch ] [-ForkRepositoryDescription ] + [-ForkRepositoryIsPrivate] [-ForkRepositoryName ] [-ForkRepositoryOwner ] + [-GithubActionSecretNameOverride ] [-Kind ] [-OutputLocation ] + [-RepositoryToken ] [-RepositoryUrl ] [-SkipGithubActionWorkflowGeneration] + [-StagingEnvironmentPolicy ] [-TemplateRepositoryUrl ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStaticWebApp -InputObject [-AllowConfigFileUpdate] [-ApiBuildCommand ] + [-ApiLocation ] [-AppArtifactLocation ] [-AppBuildCommand ] [-AppLocation ] + [-Branch ] [-ForkRepositoryDescription ] [-ForkRepositoryIsPrivate] + [-ForkRepositoryName ] [-ForkRepositoryOwner ] [-GithubActionSecretNameOverride ] + [-Kind ] [-OutputLocation ] [-RepositoryToken ] [-RepositoryUrl ] + [-SkipGithubActionWorkflowGeneration] [-StagingEnvironmentPolicy ] [-TemplateRepositoryUrl ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzStaticWebApp -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzStaticWebApp -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Description for update a new static site in an existing resource group, or update an existing static site. + +## EXAMPLES + +### Example 1: Update a static site +```powershell +Update-AzStaticWebApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb00 Microsoft.Web/staticSites +``` + +This command updates a static site. + +### Example 2: Update a static site by pipeline +```powershell +Get-AzStaticWebApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' | Update-AzStaticWebApp +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb00 Microsoft.Web/staticSites +``` + +This command updates a static site by pipeline. + +## PARAMETERS + +### -AllowConfigFileUpdate +\false\ if config file is locked for this static web app; otherwise, \true\. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiBuildCommand +A custom command to run during deployment of the Azure Functions API application. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiLocation +The path to the api code within the repository. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppArtifactLocation +Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppBuildCommand +A custom command to run during deployment of the static content application. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppLocation +The path to the app code within the repository. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Branch +The target branch in the repository. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryDescription +Description of the newly generated repository. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryIsPrivate +Whether or not the newly generated repository is a private repository. +Defaults to false (i.e. +public). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryName +Name of the newly generated repository. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryOwner +Owner of the newly generated repository. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GithubActionSecretNameOverride +Github Action secret name override. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site to create or update. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputLocation +The output path of the app after building. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryToken +A user's github repository token. +This is used to setup the Github Actions workflow file and API secrets. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryUrl +URL for the repository of the static site. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipGithubActionWorkflowGeneration +Skip Github Action workflow generation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StagingEnvironmentPolicy +State indicating whether staging environments are allowed or not allowed for a static web app. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +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). + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateRepositoryUrl +URL of the template repository. +The newly generated repository will be based on this one. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteArmResource + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/docs/Update-AzStaticWebAppUser.md b/src/Websites/Websites.Autorest/docs/Update-AzStaticWebAppUser.md new file mode 100644 index 000000000000..1ebeb01b078b --- /dev/null +++ b/src/Websites/Websites.Autorest/docs/Update-AzStaticWebAppUser.md @@ -0,0 +1,331 @@ +--- +external help file: +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/update-azstaticwebappuser +schema: 2.0.0 +--- + +# Update-AzStaticWebAppUser + +## SYNOPSIS +Description for update a user entry with the listed roles + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStaticWebAppUser -AuthProvider -Name -ResourceGroupName -UserId + [-SubscriptionId ] [-Kind ] [-Role ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityAuthproviderExpanded +``` +Update-AzStaticWebAppUser -AuthproviderInputObject -UserId [-Kind ] + [-Role ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStaticWebAppUser -InputObject [-Kind ] [-Role ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityStaticSiteExpanded +``` +Update-AzStaticWebAppUser -AuthProvider -StaticSiteInputObject -UserId + [-Kind ] [-Role ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzStaticWebAppUser -AuthProvider -Name -ResourceGroupName -UserId + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonString +``` +Update-AzStaticWebAppUser -AuthProvider -Name -ResourceGroupName -UserId + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Description for update a user entry with the listed roles + +## EXAMPLES + +### Example 1: Update a user entry with the listed roles +```powershell +Update-AzStaticWebAppUser -ResourceGroupName azure-rg-test -Name staticweb-portal01 -Authprovider 'github' -Userid 'fa4eba85fa9f4a42b5300dc4c7bb45aa' -Role 'contributor' +``` + +```output +Kind Name Type +---- ---- ---- + fa4eba85fa9f4a42b5300dc4c7bb45aa Microsoft.Web/staticSites/users +``` + +This command updates a user entry with the listed roles. + +### Example 2: Update a user entry with the listed roles by pipeline +```powershell +Get-AzStaticWebAppUser -ResourceGroupName azure-rg-test -Name staticweb-portal01 -Authprovider 'all' | Update-AzStaticWebAppUser -Role 'contributor' +``` + +```output +Kind Name Type +---- ---- ---- + fa4eba85fa9f4a42b5300dc4c7bb45aa Microsoft.Web/staticSites/users + 8bcf2cef5f3c4c8e9a58386d62bba7c3 Microsoft.Web/staticSites/users +``` + +This command updates a user entry with the listed roles by pipeline. + +## PARAMETERS + +### -AuthProvider +The auth provider for this user. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityStaticSiteExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthproviderInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: UpdateViaIdentityAuthproviderExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAuthproviderExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityStaticSiteExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The roles for the static site user, in free-form string format + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAuthproviderExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityStaticSiteExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: UpdateViaIdentityStaticSiteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +The user id of the user. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAuthproviderExpanded, UpdateViaIdentityStaticSiteExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserArmResource + +## NOTES + +## RELATED LINKS + diff --git a/src/Websites/Websites.Autorest/examples/README.md b/src/Websites/Websites.Autorest/examples/README.md deleted file mode 100644 index ac871d71fc72..000000000000 --- a/src/Websites/Websites.Autorest/examples/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# Examples -This directory contains examples from the exported cmdlets of the module. When `build-module.ps1` is ran, example stub files will be generated here. If your module support Azure Profiles, the example stubs will be in individual profile folders. These example stubs should be updated to show how the cmdlet is used. The examples are imported into the documentation when `generate-help.ps1` is ran. - -## Info -- Modifiable: yes -- Generated: partial -- Committed: yes -- Packaged: no - -## Purpose -This separates the example documentation details from the generated documentation information provided directly from the generated cmdlets. Since the cmdlets don't have examples from the REST spec, this provides a means to add examples easily. The example stubs provide the markdown format that is required. The 3 core elements are: the name of the example, the code information of the example, and the description of the example. That information, if the markdown format is followed, will be available to documentation generation and be part of the documents in the `..\docs` folder. \ No newline at end of file diff --git a/src/Websites/Websites.Autorest/generate-info.json b/src/Websites/Websites.Autorest/generate-info.json new file mode 100644 index 000000000000..781c2552d0c9 --- /dev/null +++ b/src/Websites/Websites.Autorest/generate-info.json @@ -0,0 +1,3 @@ +{ + "generate_Id": "125ff24d-ad9d-40cc-8315-6ec9bc495e35" +} diff --git a/src/Websites/Websites.sln b/src/Websites/Websites.sln index e46b363df002..2c464b90461a 100644 --- a/src/Websites/Websites.sln +++ b/src/Websites/Websites.sln @@ -1,4 +1,4 @@ - + Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 17 VisualStudioVersion = 17.0.31903.59 @@ -33,69 +33,179 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Websites", "Websites\Websit EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestFx", "..\..\tools\TestFx\TestFx.csproj", "{A3FBC234-434F-4C1C-9721-D55C14E6CF59}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Websites", "..\..\generated\Websites\Websites.Autorest\Az.Websites.csproj", "{52333454-9C85-4F05-9F31-09EC74DEDAF2}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Websites.Autorest", "Websites.Autorest", "{900AEDEE-C556-8DEE-573E-ADA5C00E8E41}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Websites", "..\..\generated\Websites\Websites.Autorest\Az.Websites.csproj", "{877240F5-C957-4436-858D-1AD0FA85DCFE}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU + Debug|x64 = Debug|x64 + Debug|x86 = Debug|x86 Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE + Release|x64 = Release|x64 + Release|x86 = Release|x86 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {DFB63A49-2771-491E-84EB-6DE370B730E1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {DFB63A49-2771-491E-84EB-6DE370B730E1}.Debug|Any CPU.Build.0 = Debug|Any CPU + {DFB63A49-2771-491E-84EB-6DE370B730E1}.Debug|x64.ActiveCfg = Debug|Any CPU + {DFB63A49-2771-491E-84EB-6DE370B730E1}.Debug|x64.Build.0 = Debug|Any CPU + {DFB63A49-2771-491E-84EB-6DE370B730E1}.Debug|x86.ActiveCfg = Debug|Any CPU + {DFB63A49-2771-491E-84EB-6DE370B730E1}.Debug|x86.Build.0 = Debug|Any CPU {DFB63A49-2771-491E-84EB-6DE370B730E1}.Release|Any CPU.ActiveCfg = Release|Any CPU {DFB63A49-2771-491E-84EB-6DE370B730E1}.Release|Any CPU.Build.0 = Release|Any CPU + {DFB63A49-2771-491E-84EB-6DE370B730E1}.Release|x64.ActiveCfg = Release|Any CPU + {DFB63A49-2771-491E-84EB-6DE370B730E1}.Release|x64.Build.0 = Release|Any CPU + {DFB63A49-2771-491E-84EB-6DE370B730E1}.Release|x86.ActiveCfg = Release|Any CPU + {DFB63A49-2771-491E-84EB-6DE370B730E1}.Release|x86.Build.0 = Release|Any CPU {F3C36C5B-76A6-41D5-874F-EB90ECD2B5BC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {F3C36C5B-76A6-41D5-874F-EB90ECD2B5BC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {F3C36C5B-76A6-41D5-874F-EB90ECD2B5BC}.Debug|x64.ActiveCfg = Debug|Any CPU + {F3C36C5B-76A6-41D5-874F-EB90ECD2B5BC}.Debug|x64.Build.0 = Debug|Any CPU + {F3C36C5B-76A6-41D5-874F-EB90ECD2B5BC}.Debug|x86.ActiveCfg = Debug|Any CPU + {F3C36C5B-76A6-41D5-874F-EB90ECD2B5BC}.Debug|x86.Build.0 = Debug|Any CPU {F3C36C5B-76A6-41D5-874F-EB90ECD2B5BC}.Release|Any CPU.ActiveCfg = Release|Any CPU {F3C36C5B-76A6-41D5-874F-EB90ECD2B5BC}.Release|Any CPU.Build.0 = Release|Any CPU + {F3C36C5B-76A6-41D5-874F-EB90ECD2B5BC}.Release|x64.ActiveCfg = Release|Any CPU + {F3C36C5B-76A6-41D5-874F-EB90ECD2B5BC}.Release|x64.Build.0 = Release|Any CPU + {F3C36C5B-76A6-41D5-874F-EB90ECD2B5BC}.Release|x86.ActiveCfg = Release|Any CPU + {F3C36C5B-76A6-41D5-874F-EB90ECD2B5BC}.Release|x86.Build.0 = Release|Any CPU {FE515EDC-2E98-4EED-9688-F1AEA3852806}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {FE515EDC-2E98-4EED-9688-F1AEA3852806}.Debug|Any CPU.Build.0 = Debug|Any CPU + {FE515EDC-2E98-4EED-9688-F1AEA3852806}.Debug|x64.ActiveCfg = Debug|Any CPU + {FE515EDC-2E98-4EED-9688-F1AEA3852806}.Debug|x64.Build.0 = Debug|Any CPU + {FE515EDC-2E98-4EED-9688-F1AEA3852806}.Debug|x86.ActiveCfg = Debug|Any CPU + {FE515EDC-2E98-4EED-9688-F1AEA3852806}.Debug|x86.Build.0 = Debug|Any CPU {FE515EDC-2E98-4EED-9688-F1AEA3852806}.Release|Any CPU.ActiveCfg = Release|Any CPU {FE515EDC-2E98-4EED-9688-F1AEA3852806}.Release|Any CPU.Build.0 = Release|Any CPU + {FE515EDC-2E98-4EED-9688-F1AEA3852806}.Release|x64.ActiveCfg = Release|Any CPU + {FE515EDC-2E98-4EED-9688-F1AEA3852806}.Release|x64.Build.0 = Release|Any CPU + {FE515EDC-2E98-4EED-9688-F1AEA3852806}.Release|x86.ActiveCfg = Release|Any CPU + {FE515EDC-2E98-4EED-9688-F1AEA3852806}.Release|x86.Build.0 = Release|Any CPU {2A9AE633-EA85-4F48-9B09-BE6CA9FD93A6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {2A9AE633-EA85-4F48-9B09-BE6CA9FD93A6}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2A9AE633-EA85-4F48-9B09-BE6CA9FD93A6}.Debug|x64.ActiveCfg = Debug|Any CPU + {2A9AE633-EA85-4F48-9B09-BE6CA9FD93A6}.Debug|x64.Build.0 = Debug|Any CPU + {2A9AE633-EA85-4F48-9B09-BE6CA9FD93A6}.Debug|x86.ActiveCfg = Debug|Any CPU + {2A9AE633-EA85-4F48-9B09-BE6CA9FD93A6}.Debug|x86.Build.0 = Debug|Any CPU {2A9AE633-EA85-4F48-9B09-BE6CA9FD93A6}.Release|Any CPU.ActiveCfg = Release|Any CPU {2A9AE633-EA85-4F48-9B09-BE6CA9FD93A6}.Release|Any CPU.Build.0 = Release|Any CPU + {2A9AE633-EA85-4F48-9B09-BE6CA9FD93A6}.Release|x64.ActiveCfg = Release|Any CPU + {2A9AE633-EA85-4F48-9B09-BE6CA9FD93A6}.Release|x64.Build.0 = Release|Any CPU + {2A9AE633-EA85-4F48-9B09-BE6CA9FD93A6}.Release|x86.ActiveCfg = Release|Any CPU + {2A9AE633-EA85-4F48-9B09-BE6CA9FD93A6}.Release|x86.Build.0 = Release|Any CPU {615A6290-6930-4908-8DC2-B465105E05F9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {615A6290-6930-4908-8DC2-B465105E05F9}.Debug|Any CPU.Build.0 = Debug|Any CPU + {615A6290-6930-4908-8DC2-B465105E05F9}.Debug|x64.ActiveCfg = Debug|Any CPU + {615A6290-6930-4908-8DC2-B465105E05F9}.Debug|x64.Build.0 = Debug|Any CPU + {615A6290-6930-4908-8DC2-B465105E05F9}.Debug|x86.ActiveCfg = Debug|Any CPU + {615A6290-6930-4908-8DC2-B465105E05F9}.Debug|x86.Build.0 = Debug|Any CPU {615A6290-6930-4908-8DC2-B465105E05F9}.Release|Any CPU.ActiveCfg = Release|Any CPU {615A6290-6930-4908-8DC2-B465105E05F9}.Release|Any CPU.Build.0 = Release|Any CPU + {615A6290-6930-4908-8DC2-B465105E05F9}.Release|x64.ActiveCfg = Release|Any CPU + {615A6290-6930-4908-8DC2-B465105E05F9}.Release|x64.Build.0 = Release|Any CPU + {615A6290-6930-4908-8DC2-B465105E05F9}.Release|x86.ActiveCfg = Release|Any CPU + {615A6290-6930-4908-8DC2-B465105E05F9}.Release|x86.Build.0 = Release|Any CPU {871E97FD-7F26-4034-A0E9-948959231BDA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {871E97FD-7F26-4034-A0E9-948959231BDA}.Debug|Any CPU.Build.0 = Debug|Any CPU + {871E97FD-7F26-4034-A0E9-948959231BDA}.Debug|x64.ActiveCfg = Debug|Any CPU + {871E97FD-7F26-4034-A0E9-948959231BDA}.Debug|x64.Build.0 = Debug|Any CPU + {871E97FD-7F26-4034-A0E9-948959231BDA}.Debug|x86.ActiveCfg = Debug|Any CPU + {871E97FD-7F26-4034-A0E9-948959231BDA}.Debug|x86.Build.0 = Debug|Any CPU {871E97FD-7F26-4034-A0E9-948959231BDA}.Release|Any CPU.ActiveCfg = Release|Any CPU {871E97FD-7F26-4034-A0E9-948959231BDA}.Release|Any CPU.Build.0 = Release|Any CPU + {871E97FD-7F26-4034-A0E9-948959231BDA}.Release|x64.ActiveCfg = Release|Any CPU + {871E97FD-7F26-4034-A0E9-948959231BDA}.Release|x64.Build.0 = Release|Any CPU + {871E97FD-7F26-4034-A0E9-948959231BDA}.Release|x86.ActiveCfg = Release|Any CPU + {871E97FD-7F26-4034-A0E9-948959231BDA}.Release|x86.Build.0 = Release|Any CPU {AB780C63-11A3-42C7-9AD3-A8771E435349}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {AB780C63-11A3-42C7-9AD3-A8771E435349}.Debug|Any CPU.Build.0 = Debug|Any CPU + {AB780C63-11A3-42C7-9AD3-A8771E435349}.Debug|x64.ActiveCfg = Debug|Any CPU + {AB780C63-11A3-42C7-9AD3-A8771E435349}.Debug|x64.Build.0 = Debug|Any CPU + {AB780C63-11A3-42C7-9AD3-A8771E435349}.Debug|x86.ActiveCfg = Debug|Any CPU + {AB780C63-11A3-42C7-9AD3-A8771E435349}.Debug|x86.Build.0 = Debug|Any CPU {AB780C63-11A3-42C7-9AD3-A8771E435349}.Release|Any CPU.ActiveCfg = Release|Any CPU {AB780C63-11A3-42C7-9AD3-A8771E435349}.Release|Any CPU.Build.0 = Release|Any CPU + {AB780C63-11A3-42C7-9AD3-A8771E435349}.Release|x64.ActiveCfg = Release|Any CPU + {AB780C63-11A3-42C7-9AD3-A8771E435349}.Release|x64.Build.0 = Release|Any CPU + {AB780C63-11A3-42C7-9AD3-A8771E435349}.Release|x86.ActiveCfg = Release|Any CPU + {AB780C63-11A3-42C7-9AD3-A8771E435349}.Release|x86.Build.0 = Release|Any CPU {A2A07768-727E-44A6-91A0-8DFC18B3A21C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {A2A07768-727E-44A6-91A0-8DFC18B3A21C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {A2A07768-727E-44A6-91A0-8DFC18B3A21C}.Debug|x64.ActiveCfg = Debug|Any CPU + {A2A07768-727E-44A6-91A0-8DFC18B3A21C}.Debug|x64.Build.0 = Debug|Any CPU + {A2A07768-727E-44A6-91A0-8DFC18B3A21C}.Debug|x86.ActiveCfg = Debug|Any CPU + {A2A07768-727E-44A6-91A0-8DFC18B3A21C}.Debug|x86.Build.0 = Debug|Any CPU {A2A07768-727E-44A6-91A0-8DFC18B3A21C}.Release|Any CPU.ActiveCfg = Release|Any CPU {A2A07768-727E-44A6-91A0-8DFC18B3A21C}.Release|Any CPU.Build.0 = Release|Any CPU + {A2A07768-727E-44A6-91A0-8DFC18B3A21C}.Release|x64.ActiveCfg = Release|Any CPU + {A2A07768-727E-44A6-91A0-8DFC18B3A21C}.Release|x64.Build.0 = Release|Any CPU + {A2A07768-727E-44A6-91A0-8DFC18B3A21C}.Release|x86.ActiveCfg = Release|Any CPU + {A2A07768-727E-44A6-91A0-8DFC18B3A21C}.Release|x86.Build.0 = Release|Any CPU {F96BA6FE-62F8-453F-943E-058691B28C24}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {F96BA6FE-62F8-453F-943E-058691B28C24}.Debug|Any CPU.Build.0 = Debug|Any CPU + {F96BA6FE-62F8-453F-943E-058691B28C24}.Debug|x64.ActiveCfg = Debug|Any CPU + {F96BA6FE-62F8-453F-943E-058691B28C24}.Debug|x64.Build.0 = Debug|Any CPU + {F96BA6FE-62F8-453F-943E-058691B28C24}.Debug|x86.ActiveCfg = Debug|Any CPU + {F96BA6FE-62F8-453F-943E-058691B28C24}.Debug|x86.Build.0 = Debug|Any CPU {F96BA6FE-62F8-453F-943E-058691B28C24}.Release|Any CPU.ActiveCfg = Release|Any CPU {F96BA6FE-62F8-453F-943E-058691B28C24}.Release|Any CPU.Build.0 = Release|Any CPU + {F96BA6FE-62F8-453F-943E-058691B28C24}.Release|x64.ActiveCfg = Release|Any CPU + {F96BA6FE-62F8-453F-943E-058691B28C24}.Release|x64.Build.0 = Release|Any CPU + {F96BA6FE-62F8-453F-943E-058691B28C24}.Release|x86.ActiveCfg = Release|Any CPU + {F96BA6FE-62F8-453F-943E-058691B28C24}.Release|x86.Build.0 = Release|Any CPU {BE011844-9309-4A55-BA04-FD41DF8F2700}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {BE011844-9309-4A55-BA04-FD41DF8F2700}.Debug|Any CPU.Build.0 = Debug|Any CPU + {BE011844-9309-4A55-BA04-FD41DF8F2700}.Debug|x64.ActiveCfg = Debug|Any CPU + {BE011844-9309-4A55-BA04-FD41DF8F2700}.Debug|x64.Build.0 = Debug|Any CPU + {BE011844-9309-4A55-BA04-FD41DF8F2700}.Debug|x86.ActiveCfg = Debug|Any CPU + {BE011844-9309-4A55-BA04-FD41DF8F2700}.Debug|x86.Build.0 = Debug|Any CPU {BE011844-9309-4A55-BA04-FD41DF8F2700}.Release|Any CPU.ActiveCfg = Release|Any CPU {BE011844-9309-4A55-BA04-FD41DF8F2700}.Release|Any CPU.Build.0 = Release|Any CPU + {BE011844-9309-4A55-BA04-FD41DF8F2700}.Release|x64.ActiveCfg = Release|Any CPU + {BE011844-9309-4A55-BA04-FD41DF8F2700}.Release|x64.Build.0 = Release|Any CPU + {BE011844-9309-4A55-BA04-FD41DF8F2700}.Release|x86.ActiveCfg = Release|Any CPU + {BE011844-9309-4A55-BA04-FD41DF8F2700}.Release|x86.Build.0 = Release|Any CPU {5EBACE61-3578-4B3D-8DF9-8CC68D78F573}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {5EBACE61-3578-4B3D-8DF9-8CC68D78F573}.Debug|Any CPU.Build.0 = Debug|Any CPU + {5EBACE61-3578-4B3D-8DF9-8CC68D78F573}.Debug|x64.ActiveCfg = Debug|Any CPU + {5EBACE61-3578-4B3D-8DF9-8CC68D78F573}.Debug|x64.Build.0 = Debug|Any CPU + {5EBACE61-3578-4B3D-8DF9-8CC68D78F573}.Debug|x86.ActiveCfg = Debug|Any CPU + {5EBACE61-3578-4B3D-8DF9-8CC68D78F573}.Debug|x86.Build.0 = Debug|Any CPU {5EBACE61-3578-4B3D-8DF9-8CC68D78F573}.Release|Any CPU.ActiveCfg = Release|Any CPU {5EBACE61-3578-4B3D-8DF9-8CC68D78F573}.Release|Any CPU.Build.0 = Release|Any CPU + {5EBACE61-3578-4B3D-8DF9-8CC68D78F573}.Release|x64.ActiveCfg = Release|Any CPU + {5EBACE61-3578-4B3D-8DF9-8CC68D78F573}.Release|x64.Build.0 = Release|Any CPU + {5EBACE61-3578-4B3D-8DF9-8CC68D78F573}.Release|x86.ActiveCfg = Release|Any CPU + {5EBACE61-3578-4B3D-8DF9-8CC68D78F573}.Release|x86.Build.0 = Release|Any CPU {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Debug|Any CPU.Build.0 = Debug|Any CPU + {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Debug|x64.ActiveCfg = Debug|Any CPU + {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Debug|x64.Build.0 = Debug|Any CPU + {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Debug|x86.ActiveCfg = Debug|Any CPU + {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Debug|x86.Build.0 = Debug|Any CPU {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Release|Any CPU.ActiveCfg = Release|Any CPU {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Release|Any CPU.Build.0 = Release|Any CPU - {52333454-9C85-4F05-9F31-09EC74DEDAF2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {52333454-9C85-4F05-9F31-09EC74DEDAF2}.Debug|Any CPU.Build.0 = Debug|Any CPU - {52333454-9C85-4F05-9F31-09EC74DEDAF2}.Release|Any CPU.ActiveCfg = Release|Any CPU - {52333454-9C85-4F05-9F31-09EC74DEDAF2}.Release|Any CPU.Build.0 = Release|Any CPU + {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Release|x64.ActiveCfg = Release|Any CPU + {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Release|x64.Build.0 = Release|Any CPU + {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Release|x86.ActiveCfg = Release|Any CPU + {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Release|x86.Build.0 = Release|Any CPU + {877240F5-C957-4436-858D-1AD0FA85DCFE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {877240F5-C957-4436-858D-1AD0FA85DCFE}.Debug|Any CPU.Build.0 = Debug|Any CPU + {877240F5-C957-4436-858D-1AD0FA85DCFE}.Debug|x64.ActiveCfg = Debug|Any CPU + {877240F5-C957-4436-858D-1AD0FA85DCFE}.Debug|x64.Build.0 = Debug|Any CPU + {877240F5-C957-4436-858D-1AD0FA85DCFE}.Debug|x86.ActiveCfg = Debug|Any CPU + {877240F5-C957-4436-858D-1AD0FA85DCFE}.Debug|x86.Build.0 = Debug|Any CPU + {877240F5-C957-4436-858D-1AD0FA85DCFE}.Release|Any CPU.ActiveCfg = Release|Any CPU + {877240F5-C957-4436-858D-1AD0FA85DCFE}.Release|Any CPU.Build.0 = Release|Any CPU + {877240F5-C957-4436-858D-1AD0FA85DCFE}.Release|x64.ActiveCfg = Release|Any CPU + {877240F5-C957-4436-858D-1AD0FA85DCFE}.Release|x64.Build.0 = Release|Any CPU + {877240F5-C957-4436-858D-1AD0FA85DCFE}.Release|x86.ActiveCfg = Release|Any CPU + {877240F5-C957-4436-858D-1AD0FA85DCFE}.Release|x86.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE EndGlobalSection GlobalSection(NestedProjects) = preSolution {DFB63A49-2771-491E-84EB-6DE370B730E1} = {41C9F58D-9ABC-43BB-A274-2E7E2F17BFAE} @@ -109,5 +219,6 @@ Global {A2A07768-727E-44A6-91A0-8DFC18B3A21C} = {4B610034-1263-4F14-8AA5-E2EB60BA7015} {BE011844-9309-4A55-BA04-FD41DF8F2700} = {EE35FE1C-D292-4F41-BD5C-3EAC5A7D3211} {A3FBC234-434F-4C1C-9721-D55C14E6CF59} = {EE35FE1C-D292-4F41-BD5C-3EAC5A7D3211} + {877240F5-C957-4436-858D-1AD0FA85DCFE} = {900AEDEE-C556-8DEE-573E-ADA5C00E8E41} EndGlobalSection EndGlobal diff --git a/src/Websites/Websites/Az.Websites.psd1 b/src/Websites/Websites/Az.Websites.psd1 index a7dd0cf31420..16ac345624e8 100644 --- a/src/Websites/Websites/Az.Websites.psd1 +++ b/src/Websites/Websites/Az.Websites.psd1 @@ -3,7 +3,7 @@ # # Generated by: Microsoft Corporation # -# Generated on: 4/30/2025 +# Generated on: 7/30/2025 # @{ @@ -53,7 +53,7 @@ DotNetFrameworkVersion = '4.7.2' # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module -RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '4.2.0'; }) +RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '5.1.1'; }) # Assemblies that must be loaded prior to importing this module RequiredAssemblies = 'Microsoft.Azure.Management.Websites.dll', @@ -61,13 +61,13 @@ RequiredAssemblies = 'Microsoft.Azure.Management.Websites.dll', 'Websites.Autorest/bin/Az.Websites.private.dll' # Script files (.ps1) that are run in the caller's environment prior to importing this module. -# ScriptsToProcess = @() +ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module -# TypesToProcess = @() +TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module -FormatsToProcess = 'Websites.Autorest\Az.Websites.format.ps1xml', +FormatsToProcess = 'Websites.Autorest/Az.Websites.format.ps1xml', 'Websites.format.ps1xml' # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess @@ -164,7 +164,7 @@ PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. - Tags = 'Azure','ResourceManager','ARM','Websites','Website','AppService' + Tags = 'Azure', 'ResourceManager', 'ARM', 'Websites', 'Website', 'AppService' # A URL to the license for this module. LicenseUri = 'https://aka.ms/azps-license' @@ -189,7 +189,7 @@ PrivateData = @{ } # End of PSData hashtable - } # End of PrivateData hashtable +} # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' diff --git a/src/Websites/Websites/help/Az.Websites.md b/src/Websites/Websites/help/Az.Websites.md index d722be927cad..20fa3b7922ed 100644 --- a/src/Websites/Websites/help/Az.Websites.md +++ b/src/Websites/Websites/help/Az.Websites.md @@ -147,25 +147,25 @@ Creates inbound services for App Service Environment. For ASEv2 ILB, this will c Creates an Azure App Service plan in a given Geo location. ### [New-AzStaticWebApp](New-AzStaticWebApp.md) -Description for Creates a new static site in an existing resource group, or updates an existing static site. +Description for create a new static site in an existing resource group, or create an existing static site. ### [New-AzStaticWebAppBuildAppSetting](New-AzStaticWebAppBuildAppSetting.md) -Description for Creates or updates the app settings of a static site build. +Description for create the app settings of a static site build. ### [New-AzStaticWebAppBuildFunctionAppSetting](New-AzStaticWebAppBuildFunctionAppSetting.md) -Description for Creates or updates the function app settings of a static site build. +Description for create the function app settings of a static site build. ### [New-AzStaticWebAppCustomDomain](New-AzStaticWebAppCustomDomain.md) -Description for Creates a new static site custom domain in an existing resource group and static site. +Description for create a new static site custom domain in an existing resource group and static site. ### [New-AzStaticWebAppFunctionAppSetting](New-AzStaticWebAppFunctionAppSetting.md) -Description for Creates or updates the function app settings of a static site. +Description for create the function app settings of a static site. ### [New-AzStaticWebAppSetting](New-AzStaticWebAppSetting.md) -Description for Creates or updates the app settings of a static site. +Description for create the app settings of a static site. ### [New-AzStaticWebAppUserRoleInvitationLink](New-AzStaticWebAppUserRoleInvitationLink.md) -Description for Creates an invitation link for a user with the role +Description for create an invitation link for a user with the role ### [New-AzWebApp](New-AzWebApp.md) Creates an Azure Web App. @@ -327,10 +327,10 @@ Description for Detach the user provided function app from the static site build Description for Detach the user provided function app from the static site ### [Update-AzStaticWebApp](Update-AzStaticWebApp.md) -Description for Creates a new static site in an existing resource group, or updates an existing static site. +Description for update a new static site in an existing resource group, or update an existing static site. ### [Update-AzStaticWebAppUser](Update-AzStaticWebAppUser.md) -Description for Updates a user entry with the listed roles +Description for update a user entry with the listed roles ### [Update-AzWebAppAccessRestrictionConfig](Update-AzWebAppAccessRestrictionConfig.md) Updates the inheritance of Main site Access Restriction config to SCM Site for an Azure Web App. diff --git a/src/Websites/Websites/help/Get-AzStaticWebApp.md b/src/Websites/Websites/help/Get-AzStaticWebApp.md index 4c58bb9513e1..603afd210440 100644 --- a/src/Websites/Websites/help/Get-AzStaticWebApp.md +++ b/src/Websites/Websites/help/Get-AzStaticWebApp.md @@ -115,7 +115,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -185,7 +184,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteArmResource ## NOTES diff --git a/src/Websites/Websites/help/Get-AzStaticWebAppBuild.md b/src/Websites/Websites/help/Get-AzStaticWebAppBuild.md index 2ea8403cc641..5e9ab55b195f 100644 --- a/src/Websites/Websites/help/Get-AzStaticWebAppBuild.md +++ b/src/Websites/Websites/help/Get-AzStaticWebAppBuild.md @@ -18,6 +18,12 @@ Get-AzStaticWebAppBuild -Name -ResourceGroupName [-Subscriptio [-DefaultProfile ] [] ``` +### GetViaIdentityStaticSite +``` +Get-AzStaticWebAppBuild -EnvironmentName -StaticSiteInputObject + [-DefaultProfile ] [] +``` + ### Get ``` Get-AzStaticWebAppBuild -EnvironmentName -Name -ResourceGroupName @@ -99,7 +105,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: GetViaIdentityStaticSite, Get Aliases: Required: True @@ -111,7 +117,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -155,6 +160,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. @@ -181,7 +201,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteBuildArmResource +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteBuildArmResource ## NOTES diff --git a/src/Websites/Websites/help/Get-AzStaticWebAppBuildAppSetting.md b/src/Websites/Websites/help/Get-AzStaticWebAppBuildAppSetting.md index 4ad5f7baa1bb..9c752bfc75b5 100644 --- a/src/Websites/Websites/help/Get-AzStaticWebAppBuildAppSetting.md +++ b/src/Websites/Websites/help/Get-AzStaticWebAppBuildAppSetting.md @@ -154,7 +154,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary ## NOTES diff --git a/src/Websites/Websites/help/Get-AzStaticWebAppBuildFunction.md b/src/Websites/Websites/help/Get-AzStaticWebAppBuildFunction.md index 9631d675f3b4..06f1698354d0 100644 --- a/src/Websites/Websites/help/Get-AzStaticWebAppBuildFunction.md +++ b/src/Websites/Websites/help/Get-AzStaticWebAppBuildFunction.md @@ -123,7 +123,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteFunctionOverviewArmResource +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteFunctionOverviewArmResource ## NOTES diff --git a/src/Websites/Websites/help/Get-AzStaticWebAppBuildFunctionAppSetting.md b/src/Websites/Websites/help/Get-AzStaticWebAppBuildFunctionAppSetting.md index ecdf071a0af2..0ef2f0b9ca06 100644 --- a/src/Websites/Websites/help/Get-AzStaticWebAppBuildFunctionAppSetting.md +++ b/src/Websites/Websites/help/Get-AzStaticWebAppBuildFunctionAppSetting.md @@ -154,7 +154,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary ## NOTES diff --git a/src/Websites/Websites/help/Get-AzStaticWebAppConfiguredRole.md b/src/Websites/Websites/help/Get-AzStaticWebAppConfiguredRole.md index 2f3ba6c1c816..f8cc64e16bc2 100644 --- a/src/Websites/Websites/help/Get-AzStaticWebAppConfiguredRole.md +++ b/src/Websites/Websites/help/Get-AzStaticWebAppConfiguredRole.md @@ -138,7 +138,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringList +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringList ## NOTES diff --git a/src/Websites/Websites/help/Get-AzStaticWebAppCustomDomain.md b/src/Websites/Websites/help/Get-AzStaticWebAppCustomDomain.md index 661e48ad7569..cbfde504f78f 100644 --- a/src/Websites/Websites/help/Get-AzStaticWebAppCustomDomain.md +++ b/src/Websites/Websites/help/Get-AzStaticWebAppCustomDomain.md @@ -18,6 +18,12 @@ Get-AzStaticWebAppCustomDomain -Name -ResourceGroupName [-Subs [-DefaultProfile ] [] ``` +### GetViaIdentityStaticSite +``` +Get-AzStaticWebAppCustomDomain -DomainName -StaticSiteInputObject + [-DefaultProfile ] [] +``` + ### Get ``` Get-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName @@ -98,7 +104,7 @@ The custom domain name. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: GetViaIdentityStaticSite, Get Aliases: Required: True @@ -110,7 +116,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -154,6 +159,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. @@ -180,7 +200,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteCustomDomainOverviewArmResource +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteCustomDomainOverviewArmResource ## NOTES diff --git a/src/Websites/Websites/help/Get-AzStaticWebAppFunction.md b/src/Websites/Websites/help/Get-AzStaticWebAppFunction.md index dbff0108428c..ec956650fe6a 100644 --- a/src/Websites/Websites/help/Get-AzStaticWebAppFunction.md +++ b/src/Websites/Websites/help/Get-AzStaticWebAppFunction.md @@ -101,7 +101,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteFunctionOverviewArmResource +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteFunctionOverviewArmResource ## NOTES diff --git a/src/Websites/Websites/help/Get-AzStaticWebAppFunctionAppSetting.md b/src/Websites/Websites/help/Get-AzStaticWebAppFunctionAppSetting.md index 180fd9c87b24..0403e9890d1a 100644 --- a/src/Websites/Websites/help/Get-AzStaticWebAppFunctionAppSetting.md +++ b/src/Websites/Websites/help/Get-AzStaticWebAppFunctionAppSetting.md @@ -138,7 +138,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary ## NOTES diff --git a/src/Websites/Websites/help/Get-AzStaticWebAppSecret.md b/src/Websites/Websites/help/Get-AzStaticWebAppSecret.md index 255ab9b05bf8..e0ee5d363069 100644 --- a/src/Websites/Websites/help/Get-AzStaticWebAppSecret.md +++ b/src/Websites/Websites/help/Get-AzStaticWebAppSecret.md @@ -138,7 +138,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary ## NOTES diff --git a/src/Websites/Websites/help/Get-AzStaticWebAppSetting.md b/src/Websites/Websites/help/Get-AzStaticWebAppSetting.md index 2aae7c862a52..81fd8233f5f7 100644 --- a/src/Websites/Websites/help/Get-AzStaticWebAppSetting.md +++ b/src/Websites/Websites/help/Get-AzStaticWebAppSetting.md @@ -138,7 +138,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary ## NOTES diff --git a/src/Websites/Websites/help/Get-AzStaticWebAppUser.md b/src/Websites/Websites/help/Get-AzStaticWebAppUser.md index aa991c944814..5b0cde8fb713 100644 --- a/src/Websites/Websites/help/Get-AzStaticWebAppUser.md +++ b/src/Websites/Websites/help/Get-AzStaticWebAppUser.md @@ -154,7 +154,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserArmResource +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserArmResource ## NOTES diff --git a/src/Websites/Websites/help/Get-AzStaticWebAppUserProvidedFunctionApp.md b/src/Websites/Websites/help/Get-AzStaticWebAppUserProvidedFunctionApp.md index 02ca78740246..570100aa96af 100644 --- a/src/Websites/Websites/help/Get-AzStaticWebAppUserProvidedFunctionApp.md +++ b/src/Websites/Websites/help/Get-AzStaticWebAppUserProvidedFunctionApp.md @@ -26,6 +26,13 @@ Get-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -Name ] ``` +### GetViaIdentityStaticSite +``` +Get-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -FunctionAppName + -StaticSiteInputObject [-DefaultProfile ] + [] +``` + ### Get ``` Get-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -FunctionAppName -Name @@ -40,6 +47,12 @@ Get-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name ] ``` +### GetViaIdentityBuild +``` +Get-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -BuildInputObject + [-DefaultProfile ] [] +``` + ### GetViaIdentity ``` Get-AzStaticWebAppUserProvidedFunctionApp -InputObject [-DefaultProfile ] @@ -118,6 +131,21 @@ This command gets the details of the user provided function app registered with ## PARAMETERS +### -BuildInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityBuild +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -139,7 +167,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: List, Get +Parameter Sets: List, GetViaIdentityStaticSite, Get Aliases: Required: True @@ -154,7 +182,7 @@ Name of the function app registered with the static site build. ```yaml Type: System.String -Parameter Sets: Get, List2 +Parameter Sets: GetViaIdentityStaticSite, Get, List2, GetViaIdentityBuild Aliases: Required: True @@ -166,7 +194,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -210,6 +237,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. @@ -236,7 +278,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserProvidedFunctionAppArmResource +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionAppArmResource ## NOTES diff --git a/src/Websites/Websites/help/Get-AzWebAppContinuousWebJob.md b/src/Websites/Websites/help/Get-AzWebAppContinuousWebJob.md index 172921671c4a..f0cba7e39fd0 100644 --- a/src/Websites/Websites/help/Get-AzWebAppContinuousWebJob.md +++ b/src/Websites/Websites/help/Get-AzWebAppContinuousWebJob.md @@ -21,13 +21,19 @@ Get-AzWebAppContinuousWebJob -AppName -ResourceGroupName [-Sub ### Get ``` Get-AzWebAppContinuousWebJob -AppName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentitySite +``` +Get-AzWebAppContinuousWebJob -Name -SiteInputObject [-DefaultProfile ] [] ``` ### GetViaIdentity ``` -Get-AzWebAppContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] +Get-AzWebAppContinuousWebJob -InputObject [-DefaultProfile ] [] ``` @@ -113,7 +119,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -132,7 +137,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentitySite Aliases: Required: True @@ -142,33 +147,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns true when the command succeeds +### -ResourceGroupName +Name of the resource group to which the resource belongs. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Get, GetViaIdentity +Type: System.String +Parameter Sets: List, Get Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceGroupName -Name of the resource group to which the resource belongs. +### -SiteInputObject +Identity Parameter ```yaml -Type: System.String -Parameter Sets: List, Get +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentitySite Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -198,7 +203,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IContinuousWebJob +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IContinuousWebJob ## NOTES diff --git a/src/Websites/Websites/help/Get-AzWebAppSlotContinuousWebJob.md b/src/Websites/Websites/help/Get-AzWebAppSlotContinuousWebJob.md index a1aa5602cfda..d21c48c0db39 100644 --- a/src/Websites/Websites/help/Get-AzWebAppSlotContinuousWebJob.md +++ b/src/Websites/Websites/help/Get-AzWebAppSlotContinuousWebJob.md @@ -22,13 +22,25 @@ Get-AzWebAppSlotContinuousWebJob -AppName -ResourceGroupName - ### Get ``` Get-AzWebAppSlotContinuousWebJob -AppName -Name -ResourceGroupName - -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + -SlotName [-SubscriptionId ] [-DefaultProfile ] [] ``` +### GetViaIdentitySite +``` +Get-AzWebAppSlotContinuousWebJob -Name -SlotName -SiteInputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityContinuouswebjob +``` +Get-AzWebAppSlotContinuousWebJob -SlotName -ContinuouswebjobInputObject + [-DefaultProfile ] [] +``` + ### GetViaIdentity ``` -Get-AzWebAppSlotContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] +Get-AzWebAppSlotContinuousWebJob -InputObject [-DefaultProfile ] [] ``` @@ -96,6 +108,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ContinuouswebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityContinuouswebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -114,7 +141,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -133,7 +159,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentitySite Aliases: Required: True @@ -143,33 +169,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns true when the command succeeds +### -ResourceGroupName +Name of the resource group to which the resource belongs. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Get, GetViaIdentity +Type: System.String +Parameter Sets: List, Get Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceGroupName -Name of the resource group to which the resource belongs. +### -SiteInputObject +Identity Parameter ```yaml -Type: System.String -Parameter Sets: List, Get +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentitySite Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -179,7 +205,7 @@ If a slot is not specified, the API deletes a deployment for the production slot ```yaml Type: System.String -Parameter Sets: List, Get +Parameter Sets: List, Get, GetViaIdentitySite, GetViaIdentityContinuouswebjob Aliases: Required: True @@ -215,7 +241,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IContinuousWebJob +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IContinuousWebJob ## NOTES diff --git a/src/Websites/Websites/help/Get-AzWebAppSlotTriggeredWebJob.md b/src/Websites/Websites/help/Get-AzWebAppSlotTriggeredWebJob.md index 9abfe2f3b07e..9ab0689219de 100644 --- a/src/Websites/Websites/help/Get-AzWebAppSlotTriggeredWebJob.md +++ b/src/Websites/Websites/help/Get-AzWebAppSlotTriggeredWebJob.md @@ -22,13 +22,25 @@ Get-AzWebAppSlotTriggeredWebJob -AppName -ResourceGroupName -S ### Get ``` Get-AzWebAppSlotTriggeredWebJob -AppName -Name -ResourceGroupName -SlotName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + [-SubscriptionId ] [-DefaultProfile ] [] ``` +### GetViaIdentitySite +``` +Get-AzWebAppSlotTriggeredWebJob -Name -SlotName -SiteInputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityTriggeredwebjob +``` +Get-AzWebAppSlotTriggeredWebJob -SlotName -TriggeredwebjobInputObject + [-DefaultProfile ] [] +``` + ### GetViaIdentity ``` -Get-AzWebAppSlotTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] +Get-AzWebAppSlotTriggeredWebJob -InputObject [-DefaultProfile ] [] ``` @@ -114,7 +126,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -133,7 +144,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentitySite Aliases: Required: True @@ -143,33 +154,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns true when the command succeeds +### -ResourceGroupName +Name of the resource group to which the resource belongs. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Get, GetViaIdentity +Type: System.String +Parameter Sets: List, Get Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceGroupName -Name of the resource group to which the resource belongs. +### -SiteInputObject +Identity Parameter ```yaml -Type: System.String -Parameter Sets: List, Get +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentitySite Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -179,7 +190,7 @@ If a slot is not specified, the API uses the production slot. ```yaml Type: System.String -Parameter Sets: List, Get +Parameter Sets: List, Get, GetViaIdentitySite, GetViaIdentityTriggeredwebjob Aliases: Required: True @@ -206,6 +217,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TriggeredwebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityTriggeredwebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -215,7 +241,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredWebJob +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredWebJob ## NOTES diff --git a/src/Websites/Websites/help/Get-AzWebAppSlotTriggeredWebJobHistory.md b/src/Websites/Websites/help/Get-AzWebAppSlotTriggeredWebJobHistory.md index f0c83f54443f..4208534cfee0 100644 --- a/src/Websites/Websites/help/Get-AzWebAppSlotTriggeredWebJobHistory.md +++ b/src/Websites/Websites/help/Get-AzWebAppSlotTriggeredWebJobHistory.md @@ -15,7 +15,7 @@ Get or list triggered web job's history for a deployment slot. ### List (Default) ``` Get-AzWebAppSlotTriggeredWebJobHistory -AppName -Name -ResourceGroupName - -SlotName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + -SlotName [-SubscriptionId ] [-DefaultProfile ] [] ``` @@ -23,13 +23,33 @@ Get-AzWebAppSlotTriggeredWebJobHistory -AppName -Name -Resourc ``` Get-AzWebAppSlotTriggeredWebJobHistory -AppName -Id -Name -ResourceGroupName -SlotName [-SubscriptionId ] [-DefaultProfile ] - [-PassThru] [] + [] +``` + +### GetViaIdentityTriggeredwebjob +``` +Get-AzWebAppSlotTriggeredWebJobHistory -Id -SlotName + -TriggeredwebjobInputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentitySite +``` +Get-AzWebAppSlotTriggeredWebJobHistory -Id -Name -SlotName + -SiteInputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityHistory +``` +Get-AzWebAppSlotTriggeredWebJobHistory -SlotName -HistoryInputObject + [-DefaultProfile ] [] ``` ### GetViaIdentity ``` Get-AzWebAppSlotTriggeredWebJobHistory -InputObject [-DefaultProfile ] - [-PassThru] [] + [] ``` ## DESCRIPTION @@ -110,12 +130,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HistoryInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityHistory +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Id History ID. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityTriggeredwebjob, GetViaIdentitySite Aliases: Required: True @@ -127,7 +162,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -146,7 +180,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: List, Get +Parameter Sets: List, Get, GetViaIdentitySite Aliases: Required: True @@ -156,33 +190,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns true when the command succeeds +### -ResourceGroupName +Name of the resource group to which the resource belongs. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Type: System.String +Parameter Sets: List, Get Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceGroupName -Name of the resource group to which the resource belongs. +### -SiteInputObject +Identity Parameter ```yaml -Type: System.String -Parameter Sets: List, Get +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentitySite Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -192,7 +226,7 @@ If a slot is not specified, the API uses the production slot. ```yaml Type: System.String -Parameter Sets: List, Get +Parameter Sets: List, Get, GetViaIdentityTriggeredwebjob, GetViaIdentitySite, GetViaIdentityHistory Aliases: Required: True @@ -219,6 +253,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TriggeredwebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityTriggeredwebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -228,7 +277,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredJobHistory +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredJobHistory ## NOTES diff --git a/src/Websites/Websites/help/Get-AzWebAppSlotWebJob.md b/src/Websites/Websites/help/Get-AzWebAppSlotWebJob.md index fa75763474ae..43b88f52b5ef 100644 --- a/src/Websites/Websites/help/Get-AzWebAppSlotWebJob.md +++ b/src/Websites/Websites/help/Get-AzWebAppSlotWebJob.md @@ -127,7 +127,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IWebJob +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebJob ## NOTES diff --git a/src/Websites/Websites/help/Get-AzWebAppTriggeredWebJob.md b/src/Websites/Websites/help/Get-AzWebAppTriggeredWebJob.md index 340f5067e2a0..d3b0684fce51 100644 --- a/src/Websites/Websites/help/Get-AzWebAppTriggeredWebJob.md +++ b/src/Websites/Websites/help/Get-AzWebAppTriggeredWebJob.md @@ -21,13 +21,19 @@ Get-AzWebAppTriggeredWebJob -AppName -ResourceGroupName [-Subs ### Get ``` Get-AzWebAppTriggeredWebJob -AppName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentitySite +``` +Get-AzWebAppTriggeredWebJob -Name -SiteInputObject [-DefaultProfile ] [] ``` ### GetViaIdentity ``` -Get-AzWebAppTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] +Get-AzWebAppTriggeredWebJob -InputObject [-DefaultProfile ] [] ``` @@ -113,7 +119,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -132,7 +137,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentitySite Aliases: Required: True @@ -142,33 +147,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns true when the command succeeds +### -ResourceGroupName +Name of the resource group to which the resource belongs. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Get, GetViaIdentity +Type: System.String +Parameter Sets: List, Get Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceGroupName -Name of the resource group to which the resource belongs. +### -SiteInputObject +Identity Parameter ```yaml -Type: System.String -Parameter Sets: List, Get +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentitySite Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -198,7 +203,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredWebJob +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredWebJob ## NOTES diff --git a/src/Websites/Websites/help/Get-AzWebAppTriggeredWebJobHistory.md b/src/Websites/Websites/help/Get-AzWebAppTriggeredWebJobHistory.md index 2986ba38e67a..ace775b3ecad 100644 --- a/src/Websites/Websites/help/Get-AzWebAppTriggeredWebJobHistory.md +++ b/src/Websites/Websites/help/Get-AzWebAppTriggeredWebJobHistory.md @@ -15,20 +15,32 @@ Get or list triggered web job's history for an app. ### List (Default) ``` Get-AzWebAppTriggeredWebJobHistory -AppName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + [-SubscriptionId ] [-DefaultProfile ] [] ``` ### Get ``` Get-AzWebAppTriggeredWebJobHistory -AppName -Id -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + [-SubscriptionId ] [-DefaultProfile ] [] ``` +### GetViaIdentityTriggeredwebjob +``` +Get-AzWebAppTriggeredWebJobHistory -Id -TriggeredwebjobInputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentitySite +``` +Get-AzWebAppTriggeredWebJobHistory -Id -Name -SiteInputObject + [-DefaultProfile ] [] +``` + ### GetViaIdentity ``` -Get-AzWebAppTriggeredWebJobHistory -InputObject [-DefaultProfile ] [-PassThru] +Get-AzWebAppTriggeredWebJobHistory -InputObject [-DefaultProfile ] [] ``` @@ -116,7 +128,7 @@ History ID. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityTriggeredwebjob, GetViaIdentitySite Aliases: Required: True @@ -128,7 +140,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -147,7 +158,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: List, Get +Parameter Sets: List, Get, GetViaIdentitySite Aliases: Required: True @@ -157,33 +168,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns true when the command succeeds +### -ResourceGroupName +Name of the resource group to which the resource belongs. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Type: System.String +Parameter Sets: List, Get Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceGroupName -Name of the resource group to which the resource belongs. +### -SiteInputObject +Identity Parameter ```yaml -Type: System.String -Parameter Sets: List, Get +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentitySite Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -204,6 +215,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TriggeredwebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentityTriggeredwebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -213,7 +239,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredJobHistory +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredJobHistory ## NOTES diff --git a/src/Websites/Websites/help/Get-AzWebAppWebJob.md b/src/Websites/Websites/help/Get-AzWebAppWebJob.md index c0c91f74257f..4f1652c66b61 100644 --- a/src/Websites/Websites/help/Get-AzWebAppWebJob.md +++ b/src/Websites/Websites/help/Get-AzWebAppWebJob.md @@ -110,7 +110,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IWebJob +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebJob ## NOTES diff --git a/src/Websites/Websites/help/New-AzStaticWebApp.md b/src/Websites/Websites/help/New-AzStaticWebApp.md index 041fabe38292..8ad69961f612 100644 --- a/src/Websites/Websites/help/New-AzStaticWebApp.md +++ b/src/Websites/Websites/help/New-AzStaticWebApp.md @@ -8,25 +8,58 @@ schema: 2.0.0 # New-AzStaticWebApp ## SYNOPSIS -Description for Creates a new static site in an existing resource group, or updates an existing static site. +Description for create a new static site in an existing resource group, or create an existing static site. ## SYNTAX +### CreateExpanded (Default) ``` New-AzStaticWebApp -Name -ResourceGroupName [-SubscriptionId ] -Location [-AllowConfigFileUpdate] [-ApiBuildCommand ] [-ApiLocation ] [-AppArtifactLocation ] [-AppBuildCommand ] [-AppLocation ] [-Branch ] [-Capacity ] - [-GithubActionSecretNameOverride ] [-IdentityType ] - [-IdentityUserAssignedIdentity ] [-Kind ] [-OutputLocation ] - [-RepositoryToken ] [-RepositoryUrl ] [-SkipGithubActionWorkflowGeneration] - [-SkuName ] [-StagingEnvironmentPolicy ] [-Tag ] - [-ForkRepositoryDescription ] [-ForkRepositoryIsPrivate] [-ForkRepositoryOwner ] - [-ForkRepositoryName ] [-TemplateRepositoryUrl ] [-DefaultProfile ] [-AsJob] + [-EnableSystemAssignedIdentity] [-ForkRepositoryDescription ] [-ForkRepositoryIsPrivate] + [-ForkRepositoryName ] [-ForkRepositoryOwner ] [-GithubActionSecretNameOverride ] + [-Kind ] [-OutputLocation ] [-RepositoryToken ] [-RepositoryUrl ] + [-SkipGithubActionWorkflowGeneration] [-SkuCapability ] [-SkuCapacityDefault ] + [-SkuCapacityElasticMaximum ] [-SkuCapacityMaximum ] [-SkuCapacityMinimum ] + [-SkuCapacityScaleType ] [-SkuFamily ] [-SkuLocation ] [-SkuName ] + [-SkuSize ] [-SkuTier ] [-StagingEnvironmentPolicy ] [-Tag ] + [-TemplateRepositoryUrl ] [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebApp -Name -ResourceGroupName [-SubscriptionId ] -JsonFilePath + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaJsonString +``` +New-AzStaticWebApp -Name -ResourceGroupName [-SubscriptionId ] -JsonString + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebApp -InputObject -Location [-AllowConfigFileUpdate] + [-ApiBuildCommand ] [-ApiLocation ] [-AppArtifactLocation ] + [-AppBuildCommand ] [-AppLocation ] [-Branch ] [-Capacity ] + [-EnableSystemAssignedIdentity] [-ForkRepositoryDescription ] [-ForkRepositoryIsPrivate] + [-ForkRepositoryName ] [-ForkRepositoryOwner ] [-GithubActionSecretNameOverride ] + [-Kind ] [-OutputLocation ] [-RepositoryToken ] [-RepositoryUrl ] + [-SkipGithubActionWorkflowGeneration] [-SkuCapability ] [-SkuCapacityDefault ] + [-SkuCapacityElasticMaximum ] [-SkuCapacityMaximum ] [-SkuCapacityMinimum ] + [-SkuCapacityScaleType ] [-SkuFamily ] [-SkuLocation ] [-SkuName ] + [-SkuSize ] [-SkuTier ] [-StagingEnvironmentPolicy ] [-Tag ] + [-TemplateRepositoryUrl ] [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Description for Creates a new static site in an existing resource group, or updates an existing static site. +Description for create a new static site in an existing resource group, or create an existing static site. ## EXAMPLES @@ -63,7 +96,7 @@ This command creates a new static site in an existing resource group, or updates ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -78,7 +111,7 @@ A custom command to run during deployment of the Azure Functions API application ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -93,7 +126,7 @@ The path to the api code within the repository. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -108,7 +141,7 @@ Deprecated: The path of the app artifacts after building (deprecated in favor of ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -123,7 +156,7 @@ A custom command to run during deployment of the static content application. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -138,7 +171,7 @@ The path to the app code within the repository. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -168,7 +201,7 @@ The target branch in the repository. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -183,7 +216,7 @@ Current number of instances assigned to the resource. ```yaml Type: System.Int32 -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -194,7 +227,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -208,12 +242,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ForkRepositoryDescription Description of the newly generated repository. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -230,7 +279,7 @@ public). ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -245,7 +294,7 @@ Name of the newly generated repository. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -260,7 +309,7 @@ Owner of the newly generated repository. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -275,7 +324,7 @@ Github Action secret name override. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -285,31 +334,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityType -Type of managed service identity. +### -InputObject +Identity Parameter ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ManagedServiceIdentityType -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded Aliases: -Required: False +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityUserAssignedIdentity -The list of user assigned identities associated with the resource. -The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} +### -JsonString +Json string supplied to the Create operation ```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateViaJsonString Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -321,7 +384,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -336,7 +399,7 @@ Resource Location. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: True @@ -351,7 +414,7 @@ Name of the static site to create or update. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -381,7 +444,7 @@ The output path of the app after building. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -397,7 +460,7 @@ This is used to setup the Github Actions workflow file and API secrets. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -412,7 +475,7 @@ URL for the repository of the static site. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -427,7 +490,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -442,7 +505,127 @@ Skip Github Action workflow generation. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapability +Capabilities of the SKU, e.g., is traffic manager enabled? + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ICapability[] +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacityDefault +Default number of workers for this App Service plan SKU. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacityElasticMaximum +Maximum number of Elastic workers for this App Service plan SKU. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacityMaximum +Maximum number of workers for this App Service plan SKU. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacityMinimum +Minimum number of workers for this App Service plan SKU. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacityScaleType +Available scale configurations for an App Service plan. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +Family code of the resource SKU. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuLocation +Locations of the SKU. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -457,7 +640,37 @@ Name of the resource SKU. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +Size specifier of the resource SKU. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +Service tier of the resource SKU. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -471,8 +684,8 @@ Accept wildcard characters: False State indicating whether staging environments are allowed or not allowed for a static web app. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -489,7 +702,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: False @@ -504,7 +717,7 @@ Resource tags. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -520,7 +733,23 @@ The newly generated repository will be based on this one. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -566,9 +795,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteArmResource ## NOTES diff --git a/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md b/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md index 7cfb3f1bec34..6f8af86017f0 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzStaticWebAppBuildAppSetting ## SYNOPSIS -Description for Creates or updates the app settings of a static site build. +Description for create the app settings of a static site build. ## SYNTAX @@ -19,6 +19,27 @@ New-AzStaticWebAppBuildAppSetting -EnvironmentName -Name -Reso [-WhatIf] [-Confirm] [] ``` +### CreateViaJsonString +``` +New-AzStaticWebAppBuildAppSetting -EnvironmentName -Name -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebAppBuildAppSetting -EnvironmentName -Name -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityStaticSiteExpanded +``` +New-AzStaticWebAppBuildAppSetting -EnvironmentName -StaticSiteInputObject + [-AppSetting ] [-Kind ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + ### CreateViaIdentityExpanded ``` New-AzStaticWebAppBuildAppSetting -InputObject [-AppSetting ] [-Kind ] @@ -26,7 +47,7 @@ New-AzStaticWebAppBuildAppSetting -InputObject [-AppSetting ``` ## DESCRIPTION -Description for Creates or updates the app settings of a static site build. +Description for create the app settings of a static site build. ## EXAMPLES @@ -45,7 +66,7 @@ This command creates or updates the app settings of a static site build. ### Example 2: Create or updates the app settings of a static site build by pipeline ```powershell -Get-AzStaticWebAppBuildAppSetting -ResourceGroupName resourceGroup -Name staticweb00 -EnvironmentName 'default' | New-AzStaticWebAppBuildAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' } +Get-AzStaticWebAppBuildAppSetting -ResourceGroupName resourceGroup -Name taticweb00 -EnvironmentName 'default' | New-AzStaticWebAppBuildAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' } ``` ```output @@ -63,7 +84,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -94,7 +115,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, CreateViaIdentityStaticSiteExpanded Aliases: Required: True @@ -106,7 +127,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -120,12 +140,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Kind Kind of resource. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -140,7 +190,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -155,7 +205,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -165,6 +215,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityStaticSiteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. @@ -172,7 +237,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False @@ -222,7 +287,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary ## NOTES diff --git a/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md b/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md index b666bad2f8c6..04e9681cebd1 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzStaticWebAppBuildFunctionAppSetting ## SYNOPSIS -Description for Creates or updates the function app settings of a static site build. +Description for create the function app settings of a static site build. ## SYNTAX @@ -19,6 +19,27 @@ New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -Name ] ``` +### CreateViaJsonString +``` +New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -Name -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -Name -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityStaticSiteExpanded +``` +New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -StaticSiteInputObject + [-AppSetting ] [-Kind ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + ### CreateViaIdentityExpanded ``` New-AzStaticWebAppBuildFunctionAppSetting -InputObject [-AppSetting ] @@ -27,7 +48,7 @@ New-AzStaticWebAppBuildFunctionAppSetting -InputObject [-App ``` ## DESCRIPTION -Description for Creates or updates the function app settings of a static site build. +Description for create the function app settings of a static site build. ## EXAMPLES @@ -64,7 +85,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -95,7 +116,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, CreateViaIdentityStaticSiteExpanded Aliases: Required: True @@ -107,7 +128,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -121,12 +141,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Kind Kind of resource. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -141,7 +191,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -156,7 +206,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -166,6 +216,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityStaticSiteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. @@ -173,7 +238,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False @@ -223,7 +288,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary ## NOTES diff --git a/src/Websites/Websites/help/New-AzStaticWebAppCustomDomain.md b/src/Websites/Websites/help/New-AzStaticWebAppCustomDomain.md index 238e224ac974..31c431fe0bfd 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppCustomDomain.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppCustomDomain.md @@ -8,18 +8,47 @@ schema: 2.0.0 # New-AzStaticWebAppCustomDomain ## SYNOPSIS -Description for Creates a new static site custom domain in an existing resource group and static site. +Description for create a new static site custom domain in an existing resource group and static site. ## SYNTAX +### CreateExpanded (Default) ``` New-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName [-SubscriptionId ] [-Kind ] [-ValidationMethod ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` +### CreateViaJsonString +``` +New-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityStaticSiteExpanded +``` +New-AzStaticWebAppCustomDomain -DomainName -StaticSiteInputObject [-Kind ] + [-ValidationMethod ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppCustomDomain -InputObject [-Kind ] [-ValidationMethod ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + ## DESCRIPTION -Description for Creates a new static site custom domain in an existing resource group and static site. +Description for create a new static site custom domain in an existing resource group and static site. ## EXAMPLES @@ -75,7 +104,52 @@ The custom domain to create. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, CreateViaIdentityStaticSiteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString Aliases: Required: True @@ -90,7 +164,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -105,7 +179,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -135,7 +209,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -145,6 +219,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityStaticSiteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. @@ -152,7 +241,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False @@ -167,7 +256,7 @@ Validation method for adding a custom domain ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -213,9 +302,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteCustomDomainOverviewArmResource +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteCustomDomainOverviewArmResource ## NOTES diff --git a/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md b/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md index 25de38bc7ced..769ffd7f164d 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzStaticWebAppFunctionAppSetting ## SYNOPSIS -Description for Creates or updates the function app settings of a static site. +Description for create the function app settings of a static site. ## SYNTAX @@ -19,6 +19,20 @@ New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-WhatIf] [-Confirm] [] ``` +### CreateViaJsonString +``` +New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + ### CreateViaIdentityExpanded ``` New-AzStaticWebAppFunctionAppSetting -InputObject [-AppSetting ] @@ -27,7 +41,7 @@ New-AzStaticWebAppFunctionAppSetting -InputObject [-AppSetti ``` ## DESCRIPTION -Description for Creates or updates the function app settings of a static site. +Description for create the function app settings of a static site. ## EXAMPLES @@ -64,7 +78,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -92,7 +106,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -106,12 +119,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Kind Kind of resource. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -126,7 +169,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -141,7 +184,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -158,7 +201,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False @@ -208,7 +251,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary ## NOTES diff --git a/src/Websites/Websites/help/New-AzStaticWebAppSetting.md b/src/Websites/Websites/help/New-AzStaticWebAppSetting.md index 7127897d4928..6edd03a6c45b 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppSetting.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppSetting.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzStaticWebAppSetting ## SYNOPSIS -Description for Creates or updates the app settings of a static site. +Description for create the app settings of a static site. ## SYNTAX @@ -19,6 +19,20 @@ New-AzStaticWebAppSetting -Name -ResourceGroupName [-Subscript [-WhatIf] [-Confirm] [] ``` +### CreateViaJsonString +``` +New-AzStaticWebAppSetting -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebAppSetting -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + ### CreateViaIdentityExpanded ``` New-AzStaticWebAppSetting -InputObject [-AppSetting ] [-Kind ] @@ -26,7 +40,7 @@ New-AzStaticWebAppSetting -InputObject [-AppSetting -ResourceGroupName ] ``` +### CreateViaJsonString +``` +New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + ### CreateViaIdentityExpanded ``` New-AzStaticWebAppUserRoleInvitationLink -InputObject [-Domain ] [-Kind ] @@ -28,7 +42,7 @@ New-AzStaticWebAppUserRoleInvitationLink -InputObject [-Doma ``` ## DESCRIPTION -Description for Creates an invitation link for a user with the role +Description for create an invitation link for a user with the role ## EXAMPLES @@ -76,7 +90,7 @@ The domain name for the static site custom domain. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -88,7 +102,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -102,12 +115,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Kind Kind of resource. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -122,7 +165,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -137,7 +180,7 @@ The number of hours the sas token stays valid ```yaml Type: System.Int32 -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -152,7 +195,7 @@ The identity provider for the static site user. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -167,7 +210,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -182,7 +225,7 @@ The roles for the static site user, in free-form string format ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -199,7 +242,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False @@ -214,7 +257,7 @@ The user id for the static site user. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -264,7 +307,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserInvitationResponseResource +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserInvitationResponseResource ## NOTES diff --git a/src/Websites/Websites/help/Register-AzStaticWebAppUserProvidedFunctionApp.md b/src/Websites/Websites/help/Register-AzStaticWebAppUserProvidedFunctionApp.md index 0c1ad44cbd12..eb62a6843716 100644 --- a/src/Websites/Websites/help/Register-AzStaticWebAppUserProvidedFunctionApp.md +++ b/src/Websites/Websites/help/Register-AzStaticWebAppUserProvidedFunctionApp.md @@ -12,20 +12,36 @@ Description for Register a user provided function app with a static site build ## SYNTAX -### RegisterExpanded1 (Default) +### RegisterViaJsonFilePath1 (Default) ``` Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name - -ResourceGroupName [-SubscriptionId ] [-Forced] [-FunctionAppRegion ] - [-FunctionAppResourceId ] [-Kind ] [-DefaultProfile ] [-AsJob] [-NoWait] + -ResourceGroupName [-SubscriptionId ] [-Forced] -JsonFilePath + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### RegisterViaJsonString +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name + -ResourceGroupName -EnvironmentName [-SubscriptionId ] [-Forced] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` -### RegisterExpanded +### RegisterViaJsonFilePath ``` Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name -ResourceGroupName -EnvironmentName [-SubscriptionId ] [-Forced] - [-FunctionAppRegion ] [-FunctionAppResourceId ] [-Kind ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### RegisterViaJsonString1 +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name + -ResourceGroupName [-SubscriptionId ] [-Forced] -JsonString + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -99,7 +115,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: RegisterExpanded +Parameter Sets: RegisterViaJsonString, RegisterViaJsonFilePath Aliases: Required: True @@ -140,45 +156,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FunctionAppRegion -The region of the function app registered with the static site +### -JsonFilePath +Path of Json file supplied to the Register operation ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: RegisterViaJsonFilePath1, RegisterViaJsonFilePath Aliases: -Required: False -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 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Kind -Kind of resource. +### -JsonString +Json string supplied to the Register operation ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: RegisterViaJsonString, RegisterViaJsonString1 Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -285,7 +286,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserProvidedFunctionAppArmResource +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionAppArmResource ## NOTES diff --git a/src/Websites/Websites/help/Remove-AzStaticWebApp.md b/src/Websites/Websites/help/Remove-AzStaticWebApp.md index 20253269db7b..925b4bf4385b 100644 --- a/src/Websites/Websites/help/Remove-AzStaticWebApp.md +++ b/src/Websites/Websites/help/Remove-AzStaticWebApp.md @@ -79,7 +79,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity diff --git a/src/Websites/Websites/help/Remove-AzStaticWebAppAttachedRepository.md b/src/Websites/Websites/help/Remove-AzStaticWebAppAttachedRepository.md index 729f1debf53e..6d3e1d04c8da 100644 --- a/src/Websites/Websites/help/Remove-AzStaticWebAppAttachedRepository.md +++ b/src/Websites/Websites/help/Remove-AzStaticWebAppAttachedRepository.md @@ -72,7 +72,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity diff --git a/src/Websites/Websites/help/Remove-AzStaticWebAppBuild.md b/src/Websites/Websites/help/Remove-AzStaticWebAppBuild.md index 781d4975e984..caf815ed9e1b 100644 --- a/src/Websites/Websites/help/Remove-AzStaticWebAppBuild.md +++ b/src/Websites/Websites/help/Remove-AzStaticWebAppBuild.md @@ -19,6 +19,13 @@ Remove-AzStaticWebAppBuild -EnvironmentName -Name -ResourceGro [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentityStaticSite +``` +Remove-AzStaticWebAppBuild -EnvironmentName -StaticSiteInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + ### DeleteViaIdentity ``` Remove-AzStaticWebAppBuild -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] @@ -82,7 +89,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityStaticSite Aliases: Required: True @@ -94,7 +101,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -168,6 +174,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. diff --git a/src/Websites/Websites/help/Remove-AzStaticWebAppCustomDomain.md b/src/Websites/Websites/help/Remove-AzStaticWebAppCustomDomain.md index d3aeb181559a..559c9f235209 100644 --- a/src/Websites/Websites/help/Remove-AzStaticWebAppCustomDomain.md +++ b/src/Websites/Websites/help/Remove-AzStaticWebAppCustomDomain.md @@ -19,6 +19,13 @@ Remove-AzStaticWebAppCustomDomain -DomainName -Name -ResourceG [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentityStaticSite +``` +Remove-AzStaticWebAppCustomDomain -DomainName -StaticSiteInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + ### DeleteViaIdentity ``` Remove-AzStaticWebAppCustomDomain -InputObject [-DefaultProfile ] [-AsJob] @@ -82,7 +89,7 @@ The custom domain to delete. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityStaticSite Aliases: Required: True @@ -94,7 +101,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -168,6 +174,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. diff --git a/src/Websites/Websites/help/Remove-AzStaticWebAppUser.md b/src/Websites/Websites/help/Remove-AzStaticWebAppUser.md index 5f5015e6587c..7ef1929d0a53 100644 --- a/src/Websites/Websites/help/Remove-AzStaticWebAppUser.md +++ b/src/Websites/Websites/help/Remove-AzStaticWebAppUser.md @@ -19,6 +19,20 @@ Remove-AzStaticWebAppUser -AuthProvider -Name -ResourceGroupNa [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentityStaticSite +``` +Remove-AzStaticWebAppUser -AuthProvider -UserId -StaticSiteInputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### DeleteViaIdentityAuthprovider +``` +Remove-AzStaticWebAppUser -UserId -AuthproviderInputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + ### DeleteViaIdentity ``` Remove-AzStaticWebAppUser -InputObject [-DefaultProfile ] [-PassThru] @@ -52,7 +66,7 @@ The auth provider for this user. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityStaticSite Aliases: Required: True @@ -62,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AuthproviderInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentityAuthprovider +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -80,7 +109,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -139,6 +167,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. @@ -161,7 +204,7 @@ The user id of the user. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityStaticSite, DeleteViaIdentityAuthprovider Aliases: Required: True diff --git a/src/Websites/Websites/help/Remove-AzWebAppContinuousWebJob.md b/src/Websites/Websites/help/Remove-AzWebAppContinuousWebJob.md index f74b1ebe1d2c..9ab73683ac1b 100644 --- a/src/Websites/Websites/help/Remove-AzWebAppContinuousWebJob.md +++ b/src/Websites/Websites/help/Remove-AzWebAppContinuousWebJob.md @@ -19,6 +19,13 @@ Remove-AzWebAppContinuousWebJob -AppName -Name -ResourceGroupN [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentitySite +``` +Remove-AzWebAppContinuousWebJob -Name -SiteInputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + ### DeleteViaIdentity ``` Remove-AzWebAppContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] @@ -79,7 +86,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -98,7 +104,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentitySite Aliases: Required: True @@ -138,6 +144,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. diff --git a/src/Websites/Websites/help/Remove-AzWebAppSlotContinuousWebJob.md b/src/Websites/Websites/help/Remove-AzWebAppSlotContinuousWebJob.md index 14287d44e512..8f09b15eb8ae 100644 --- a/src/Websites/Websites/help/Remove-AzWebAppSlotContinuousWebJob.md +++ b/src/Websites/Websites/help/Remove-AzWebAppSlotContinuousWebJob.md @@ -19,6 +19,20 @@ Remove-AzWebAppSlotContinuousWebJob -AppName -Name -ResourceGr [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentitySite +``` +Remove-AzWebAppSlotContinuousWebJob -Name -SlotName -SiteInputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### DeleteViaIdentityContinuouswebjob +``` +Remove-AzWebAppSlotContinuousWebJob -SlotName -ContinuouswebjobInputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + ### DeleteViaIdentity ``` Remove-AzWebAppSlotContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] @@ -61,6 +75,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ContinuouswebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentityContinuouswebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -79,7 +108,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -98,7 +126,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentitySite Aliases: Required: True @@ -138,13 +166,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SlotName Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentitySite, DeleteViaIdentityContinuouswebjob Aliases: Required: True diff --git a/src/Websites/Websites/help/Remove-AzWebAppSlotTriggeredWebJob.md b/src/Websites/Websites/help/Remove-AzWebAppSlotTriggeredWebJob.md index 417ac61ff322..e5ab1f6fcb9c 100644 --- a/src/Websites/Websites/help/Remove-AzWebAppSlotTriggeredWebJob.md +++ b/src/Websites/Websites/help/Remove-AzWebAppSlotTriggeredWebJob.md @@ -19,6 +19,20 @@ Remove-AzWebAppSlotTriggeredWebJob -AppName -Name -ResourceGro [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentitySite +``` +Remove-AzWebAppSlotTriggeredWebJob -Name -SlotName -SiteInputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### DeleteViaIdentityTriggeredwebjob +``` +Remove-AzWebAppSlotTriggeredWebJob -SlotName -TriggeredwebjobInputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + ### DeleteViaIdentity ``` Remove-AzWebAppSlotTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] @@ -79,7 +93,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -98,7 +111,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentitySite Aliases: Required: True @@ -138,13 +151,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SlotName Name of the deployment slot. If a slot is not specified, the API deletes web job for the production slot. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentitySite, DeleteViaIdentityTriggeredwebjob Aliases: Required: True @@ -171,6 +199,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TriggeredwebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentityTriggeredwebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. diff --git a/src/Websites/Websites/help/Remove-AzWebAppTriggeredWebJob.md b/src/Websites/Websites/help/Remove-AzWebAppTriggeredWebJob.md index 711ff334c862..3bfe88ac6884 100644 --- a/src/Websites/Websites/help/Remove-AzWebAppTriggeredWebJob.md +++ b/src/Websites/Websites/help/Remove-AzWebAppTriggeredWebJob.md @@ -19,6 +19,12 @@ Remove-AzWebAppTriggeredWebJob -AppName -Name -ResourceGroupNa [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentitySite +``` +Remove-AzWebAppTriggeredWebJob -Name -SiteInputObject [-DefaultProfile ] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + ### DeleteViaIdentity ``` Remove-AzWebAppTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] @@ -79,7 +85,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -98,7 +103,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentitySite Aliases: Required: True @@ -138,6 +143,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. diff --git a/src/Websites/Websites/help/Reset-AzStaticWebAppApiKey.md b/src/Websites/Websites/help/Reset-AzStaticWebAppApiKey.md index f9cebafda451..5d01f3b9fb8b 100644 --- a/src/Websites/Websites/help/Reset-AzStaticWebAppApiKey.md +++ b/src/Websites/Websites/help/Reset-AzStaticWebAppApiKey.md @@ -19,6 +19,20 @@ Reset-AzStaticWebAppApiKey -Name -ResourceGroupName [-Subscrip [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ResetViaJsonString +``` +Reset-AzStaticWebAppApiKey -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### ResetViaJsonFilePath +``` +Reset-AzStaticWebAppApiKey -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + ### ResetViaIdentityExpanded ``` Reset-AzStaticWebAppApiKey -InputObject [-Kind ] [-RepositoryToken ] @@ -65,7 +79,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -79,12 +92,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Reset operation + +```yaml +Type: System.String +Parameter Sets: ResetViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Reset operation + +```yaml +Type: System.String +Parameter Sets: ResetViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Kind Kind of resource. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: ResetExpanded, ResetViaIdentityExpanded Aliases: Required: False @@ -99,7 +142,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: ResetExpanded +Parameter Sets: ResetExpanded, ResetViaJsonString, ResetViaJsonFilePath Aliases: Required: True @@ -129,7 +172,7 @@ The token which proves admin privileges to the repository. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: ResetExpanded, ResetViaIdentityExpanded Aliases: Required: False @@ -144,7 +187,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: ResetExpanded +Parameter Sets: ResetExpanded, ResetViaJsonString, ResetViaJsonFilePath Aliases: Required: True @@ -159,7 +202,7 @@ Determines whether the repository should be updated with the new properties. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: ResetExpanded, ResetViaIdentityExpanded Aliases: Required: False @@ -176,7 +219,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: ResetExpanded +Parameter Sets: ResetExpanded, ResetViaJsonString, ResetViaJsonFilePath Aliases: Required: False diff --git a/src/Websites/Websites/help/Start-AzWebAppContinuousWebJob.md b/src/Websites/Websites/help/Start-AzWebAppContinuousWebJob.md index 22a02ac31b76..f3b5e972a097 100644 --- a/src/Websites/Websites/help/Start-AzWebAppContinuousWebJob.md +++ b/src/Websites/Websites/help/Start-AzWebAppContinuousWebJob.md @@ -19,6 +19,12 @@ Start-AzWebAppContinuousWebJob -AppName -Name -ResourceGroupNa [-WhatIf] [-Confirm] [] ``` +### StartViaIdentitySite +``` +Start-AzWebAppContinuousWebJob -Name -SiteInputObject [-DefaultProfile ] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + ### StartViaIdentity ``` Start-AzWebAppContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] @@ -79,7 +85,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -98,7 +103,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Start +Parameter Sets: Start, StartViaIdentitySite Aliases: Required: True @@ -138,6 +143,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StartViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. diff --git a/src/Websites/Websites/help/Start-AzWebAppSlotContinuousWebJob.md b/src/Websites/Websites/help/Start-AzWebAppSlotContinuousWebJob.md index 8fbba83fa303..47178153ce40 100644 --- a/src/Websites/Websites/help/Start-AzWebAppSlotContinuousWebJob.md +++ b/src/Websites/Websites/help/Start-AzWebAppSlotContinuousWebJob.md @@ -19,6 +19,20 @@ Start-AzWebAppSlotContinuousWebJob -AppName -Name -ResourceGro [-WhatIf] [-Confirm] [] ``` +### StartViaIdentitySite +``` +Start-AzWebAppSlotContinuousWebJob -Name -SlotName -SiteInputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### StartViaIdentityContinuouswebjob +``` +Start-AzWebAppSlotContinuousWebJob -SlotName -ContinuouswebjobInputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + ### StartViaIdentity ``` Start-AzWebAppSlotContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] @@ -61,6 +75,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ContinuouswebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StartViaIdentityContinuouswebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -79,7 +108,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -98,7 +126,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Start +Parameter Sets: Start, StartViaIdentitySite Aliases: Required: True @@ -138,13 +166,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StartViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SlotName Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. ```yaml Type: System.String -Parameter Sets: Start +Parameter Sets: Start, StartViaIdentitySite, StartViaIdentityContinuouswebjob Aliases: Required: True diff --git a/src/Websites/Websites/help/Start-AzWebAppSlotTriggeredWebJob.md b/src/Websites/Websites/help/Start-AzWebAppSlotTriggeredWebJob.md index 29dbf31fa341..2195ca1e0b4f 100644 --- a/src/Websites/Websites/help/Start-AzWebAppSlotTriggeredWebJob.md +++ b/src/Websites/Websites/help/Start-AzWebAppSlotTriggeredWebJob.md @@ -19,6 +19,20 @@ Start-AzWebAppSlotTriggeredWebJob -AppName -Name -ResourceGrou [-WhatIf] [-Confirm] [] ``` +### RunViaIdentitySite +``` +Start-AzWebAppSlotTriggeredWebJob -Name -SlotName -SiteInputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### RunViaIdentityTriggeredwebjob +``` +Start-AzWebAppSlotTriggeredWebJob -SlotName -TriggeredwebjobInputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + ### RunViaIdentity ``` Start-AzWebAppSlotTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] @@ -79,7 +93,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -98,7 +111,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Run +Parameter Sets: Run, RunViaIdentitySite Aliases: Required: True @@ -138,13 +151,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RunViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SlotName Name of the deployment slot. If a slot is not specified, the API uses the production slot. ```yaml Type: System.String -Parameter Sets: Run +Parameter Sets: Run, RunViaIdentitySite, RunViaIdentityTriggeredwebjob Aliases: Required: True @@ -171,6 +199,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TriggeredwebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RunViaIdentityTriggeredwebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. diff --git a/src/Websites/Websites/help/Start-AzWebAppTriggeredWebJob.md b/src/Websites/Websites/help/Start-AzWebAppTriggeredWebJob.md index c66a7040e3df..425b62ede667 100644 --- a/src/Websites/Websites/help/Start-AzWebAppTriggeredWebJob.md +++ b/src/Websites/Websites/help/Start-AzWebAppTriggeredWebJob.md @@ -19,6 +19,12 @@ Start-AzWebAppTriggeredWebJob -AppName -Name -ResourceGroupNam [-WhatIf] [-Confirm] [] ``` +### RunViaIdentitySite +``` +Start-AzWebAppTriggeredWebJob -Name -SiteInputObject [-DefaultProfile ] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + ### RunViaIdentity ``` Start-AzWebAppTriggeredWebJob -InputObject [-DefaultProfile ] [-PassThru] @@ -79,7 +85,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -98,7 +103,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Run +Parameter Sets: Run, RunViaIdentitySite Aliases: Required: True @@ -138,6 +143,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RunViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. diff --git a/src/Websites/Websites/help/Stop-AzWebAppContinuousWebJob.md b/src/Websites/Websites/help/Stop-AzWebAppContinuousWebJob.md index 23f95e57c250..ad4b1a77812a 100644 --- a/src/Websites/Websites/help/Stop-AzWebAppContinuousWebJob.md +++ b/src/Websites/Websites/help/Stop-AzWebAppContinuousWebJob.md @@ -19,6 +19,12 @@ Stop-AzWebAppContinuousWebJob -AppName -Name -ResourceGroupNam [-WhatIf] [-Confirm] [] ``` +### StopViaIdentitySite +``` +Stop-AzWebAppContinuousWebJob -Name -SiteInputObject [-DefaultProfile ] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + ### StopViaIdentity ``` Stop-AzWebAppContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] @@ -79,7 +85,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -98,7 +103,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Stop +Parameter Sets: Stop, StopViaIdentitySite Aliases: Required: True @@ -138,6 +143,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StopViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. diff --git a/src/Websites/Websites/help/Stop-AzWebAppSlotContinuousWebJob.md b/src/Websites/Websites/help/Stop-AzWebAppSlotContinuousWebJob.md index 6390ab96dbd6..2c43dd5f53ea 100644 --- a/src/Websites/Websites/help/Stop-AzWebAppSlotContinuousWebJob.md +++ b/src/Websites/Websites/help/Stop-AzWebAppSlotContinuousWebJob.md @@ -19,6 +19,20 @@ Stop-AzWebAppSlotContinuousWebJob -AppName -Name -ResourceGrou [-WhatIf] [-Confirm] [] ``` +### StopViaIdentitySite +``` +Stop-AzWebAppSlotContinuousWebJob -Name -SlotName -SiteInputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### StopViaIdentityContinuouswebjob +``` +Stop-AzWebAppSlotContinuousWebJob -SlotName -ContinuouswebjobInputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + ### StopViaIdentity ``` Stop-AzWebAppSlotContinuousWebJob -InputObject [-DefaultProfile ] [-PassThru] @@ -61,6 +75,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ContinuouswebjobInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StopViaIdentityContinuouswebjob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -79,7 +108,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -98,7 +126,7 @@ Name of Web Job. ```yaml Type: System.String -Parameter Sets: Stop +Parameter Sets: Stop, StopViaIdentitySite Aliases: Required: True @@ -138,13 +166,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: StopViaIdentitySite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SlotName Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. ```yaml Type: System.String -Parameter Sets: Stop +Parameter Sets: Stop, StopViaIdentitySite, StopViaIdentityContinuouswebjob Aliases: Required: True diff --git a/src/Websites/Websites/help/Test-AzStaticWebAppCustomDomain.md b/src/Websites/Websites/help/Test-AzStaticWebAppCustomDomain.md index e681f4a4eece..79b69865b004 100644 --- a/src/Websites/Websites/help/Test-AzStaticWebAppCustomDomain.md +++ b/src/Websites/Websites/help/Test-AzStaticWebAppCustomDomain.md @@ -19,6 +19,44 @@ Test-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGro [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ValidateViaJsonString +``` +Test-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### ValidateViaJsonFilePath +``` +Test-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### ValidateViaIdentityStaticSiteExpanded +``` +Test-AzStaticWebAppCustomDomain -DomainName -StaticSiteInputObject + [-Kind ] [-ValidationMethod ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### ValidateViaIdentityStaticSite +``` +Test-AzStaticWebAppCustomDomain -DomainName -StaticSiteInputObject + -StaticSiteCustomDomainRequestPropertiesEnvelope + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### Validate +``` +Test-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName + [-SubscriptionId ] + -StaticSiteCustomDomainRequestPropertiesEnvelope + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + ### ValidateViaIdentityExpanded ``` Test-AzStaticWebAppCustomDomain -InputObject [-Kind ] [-ValidationMethod ] @@ -26,6 +64,14 @@ Test-AzStaticWebAppCustomDomain -InputObject [-Kind [-Confirm] [] ``` +### ValidateViaIdentity +``` +Test-AzStaticWebAppCustomDomain -InputObject + -StaticSiteCustomDomainRequestPropertiesEnvelope + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + ## DESCRIPTION Description for Validates a particular custom domain can be added to a static site. @@ -83,7 +129,7 @@ The custom domain to validate. ```yaml Type: System.String -Parameter Sets: ValidateExpanded +Parameter Sets: ValidateExpanded, ValidateViaJsonString, ValidateViaJsonFilePath, ValidateViaIdentityStaticSiteExpanded, ValidateViaIdentityStaticSite, Validate Aliases: Required: True @@ -95,11 +141,10 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: ValidateViaIdentityExpanded +Parameter Sets: ValidateViaIdentityExpanded, ValidateViaIdentity Aliases: Required: True @@ -109,12 +154,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Validate operation + +```yaml +Type: System.String +Parameter Sets: ValidateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Validate operation + +```yaml +Type: System.String +Parameter Sets: ValidateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Kind Kind of resource. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: ValidateExpanded, ValidateViaIdentityStaticSiteExpanded, ValidateViaIdentityExpanded Aliases: Required: False @@ -129,7 +204,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: ValidateExpanded +Parameter Sets: ValidateExpanded, ValidateViaJsonString, ValidateViaJsonFilePath, Validate Aliases: Required: True @@ -174,7 +249,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: ValidateExpanded +Parameter Sets: ValidateExpanded, ValidateViaJsonString, ValidateViaJsonFilePath, Validate Aliases: Required: True @@ -184,6 +259,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSiteCustomDomainRequestPropertiesEnvelope +Static Site Custom Domain Request Properties ARM resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteCustomDomainRequestPropertiesArmResource +Parameter Sets: ValidateViaIdentityStaticSite, Validate, ValidateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: ValidateViaIdentityStaticSiteExpanded, ValidateViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. @@ -191,7 +296,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: ValidateExpanded +Parameter Sets: ValidateExpanded, ValidateViaJsonString, ValidateViaJsonFilePath, Validate Aliases: Required: False @@ -206,7 +311,7 @@ Validation method for adding a custom domain ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: ValidateExpanded, ValidateViaIdentityStaticSiteExpanded, ValidateViaIdentityExpanded Aliases: Required: False @@ -252,6 +357,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteCustomDomainRequestPropertiesArmResource + ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity ## OUTPUTS diff --git a/src/Websites/Websites/help/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md b/src/Websites/Websites/help/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md index ca89f3d3a834..e66cd1122505 100644 --- a/src/Websites/Websites/help/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md +++ b/src/Websites/Websites/help/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md @@ -19,6 +19,20 @@ Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -EnvironmentName [-WhatIf] [-Confirm] [] ``` +### DetachViaIdentityStaticSite +``` +Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -EnvironmentName -FunctionAppName + -StaticSiteInputObject [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DetachViaIdentityBuild +``` +Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -FunctionAppName + -BuildInputObject [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + ### DetachViaIdentity ``` Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -InputObject @@ -47,6 +61,21 @@ This command unregisters the user provided function app from the static site bui ## PARAMETERS +### -BuildInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DetachViaIdentityBuild +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -68,7 +97,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: Detach +Parameter Sets: Detach, DetachViaIdentityStaticSite Aliases: Required: True @@ -83,7 +112,7 @@ Name of the function app registered with the static site build. ```yaml Type: System.String -Parameter Sets: Detach +Parameter Sets: Detach, DetachViaIdentityStaticSite, DetachViaIdentityBuild Aliases: Required: True @@ -95,7 +124,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -154,6 +182,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DetachViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. diff --git a/src/Websites/Websites/help/Unregister-AzStaticWebAppUserProvidedFunctionApp.md b/src/Websites/Websites/help/Unregister-AzStaticWebAppUserProvidedFunctionApp.md index fba796254e10..980ae5a491ac 100644 --- a/src/Websites/Websites/help/Unregister-AzStaticWebAppUserProvidedFunctionApp.md +++ b/src/Websites/Websites/help/Unregister-AzStaticWebAppUserProvidedFunctionApp.md @@ -19,6 +19,13 @@ Unregister-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name [-WhatIf] [-Confirm] [] ``` +### DetachViaIdentityStaticSite +``` +Unregister-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName + -StaticSiteInputObject [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + ### DetachViaIdentity ``` Unregister-AzStaticWebAppUserProvidedFunctionApp -InputObject [-DefaultProfile ] @@ -67,7 +74,7 @@ Name of the function app registered with the static site. ```yaml Type: System.String -Parameter Sets: Detach +Parameter Sets: Detach, DetachViaIdentityStaticSite Aliases: Required: True @@ -79,7 +86,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -138,6 +144,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: DetachViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. diff --git a/src/Websites/Websites/help/Update-AzStaticWebApp.md b/src/Websites/Websites/help/Update-AzStaticWebApp.md index 48172045b38b..b21d52f1bc9b 100644 --- a/src/Websites/Websites/help/Update-AzStaticWebApp.md +++ b/src/Websites/Websites/help/Update-AzStaticWebApp.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzStaticWebApp ## SYNOPSIS -Description for Creates a new static site in an existing resource group, or updates an existing static site. +Description for update a new static site in an existing resource group, or update an existing static site. ## SYNTAX @@ -20,8 +20,22 @@ Update-AzStaticWebApp -Name -ResourceGroupName [-SubscriptionI [-ForkRepositoryIsPrivate] [-ForkRepositoryName ] [-ForkRepositoryOwner ] [-GithubActionSecretNameOverride ] [-Kind ] [-OutputLocation ] [-RepositoryToken ] [-RepositoryUrl ] [-SkipGithubActionWorkflowGeneration] - [-StagingEnvironmentPolicy ] [-TemplateRepositoryUrl ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-StagingEnvironmentPolicy ] [-TemplateRepositoryUrl ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonString +``` +Update-AzStaticWebApp -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzStaticWebApp -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded @@ -31,13 +45,12 @@ Update-AzStaticWebApp -InputObject [-AllowConfigFileUpdate] [-Branch ] [-ForkRepositoryDescription ] [-ForkRepositoryIsPrivate] [-ForkRepositoryName ] [-ForkRepositoryOwner ] [-GithubActionSecretNameOverride ] [-Kind ] [-OutputLocation ] [-RepositoryToken ] [-RepositoryUrl ] - [-SkipGithubActionWorkflowGeneration] [-StagingEnvironmentPolicy ] - [-TemplateRepositoryUrl ] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] + [-SkipGithubActionWorkflowGeneration] [-StagingEnvironmentPolicy ] [-TemplateRepositoryUrl ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Description for Creates a new static site in an existing resource group, or updates an existing static site. +Description for update a new static site in an existing resource group, or update an existing static site. ## EXAMPLES @@ -74,7 +87,7 @@ This command updates a static site by pipeline. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -89,7 +102,7 @@ A custom command to run during deployment of the Azure Functions API application ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -104,7 +117,7 @@ The path to the api code within the repository. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -119,7 +132,7 @@ Deprecated: The path of the app artifacts after building (deprecated in favor of ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -134,7 +147,7 @@ A custom command to run during deployment of the static content application. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -149,7 +162,7 @@ The path to the app code within the repository. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -164,7 +177,7 @@ The target branch in the repository. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -195,7 +208,7 @@ Description of the newly generated repository. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -212,7 +225,7 @@ public). ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -227,7 +240,7 @@ Name of the newly generated repository. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -242,7 +255,7 @@ Owner of the newly generated repository. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -257,7 +270,7 @@ Github Action secret name override. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -269,7 +282,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -283,12 +295,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Kind Kind of resource. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -303,7 +345,7 @@ Name of the static site to create or update. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: True @@ -318,7 +360,7 @@ The output path of the app after building. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -334,7 +376,7 @@ This is used to setup the Github Actions workflow file and API secrets. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -349,7 +391,7 @@ URL for the repository of the static site. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -364,7 +406,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: True @@ -379,7 +421,7 @@ Skip Github Action workflow generation. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -393,8 +435,8 @@ Accept wildcard characters: False State indicating whether staging environments are allowed or not allowed for a static web app. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy -Parameter Sets: (All) +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -411,7 +453,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: False @@ -427,7 +469,7 @@ The newly generated repository will be based on this one. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -477,7 +519,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteArmResource ## NOTES diff --git a/src/Websites/Websites/help/Update-AzStaticWebAppUser.md b/src/Websites/Websites/help/Update-AzStaticWebAppUser.md index 20d373ed11da..c0fd0a919d98 100644 --- a/src/Websites/Websites/help/Update-AzStaticWebAppUser.md +++ b/src/Websites/Websites/help/Update-AzStaticWebAppUser.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzStaticWebAppUser ## SYNOPSIS -Description for Updates a user entry with the listed roles +Description for update a user entry with the listed roles ## SYNTAX @@ -19,6 +19,34 @@ Update-AzStaticWebAppUser -AuthProvider -Name -ResourceGroupNa [-WhatIf] [-Confirm] [] ``` +### UpdateViaJsonString +``` +Update-AzStaticWebAppUser -AuthProvider -Name -ResourceGroupName + [-SubscriptionId ] -UserId -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzStaticWebAppUser -AuthProvider -Name -ResourceGroupName + [-SubscriptionId ] -UserId -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityStaticSiteExpanded +``` +Update-AzStaticWebAppUser -AuthProvider -UserId -StaticSiteInputObject + [-Kind ] [-Role ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### UpdateViaIdentityAuthproviderExpanded +``` +Update-AzStaticWebAppUser -UserId -AuthproviderInputObject [-Kind ] + [-Role ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + ### UpdateViaIdentityExpanded ``` Update-AzStaticWebAppUser -InputObject [-Kind ] [-Role ] @@ -26,7 +54,7 @@ Update-AzStaticWebAppUser -InputObject [-Kind ] [-Ro ``` ## DESCRIPTION -Description for Updates a user entry with the listed roles +Description for update a user entry with the listed roles ## EXAMPLES @@ -64,7 +92,7 @@ The auth provider for this user. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityStaticSiteExpanded Aliases: Required: True @@ -74,6 +102,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AuthproviderInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: UpdateViaIdentityAuthproviderExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -92,7 +135,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity @@ -106,12 +148,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Kind Kind of resource. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityStaticSiteExpanded, UpdateViaIdentityAuthproviderExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -126,7 +198,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: True @@ -141,7 +213,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: True @@ -156,7 +228,7 @@ The roles for the static site user, in free-form string format ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityStaticSiteExpanded, UpdateViaIdentityAuthproviderExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -166,6 +238,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: UpdateViaIdentityStaticSiteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. @@ -173,7 +260,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: False @@ -188,7 +275,7 @@ The user id of the user. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityStaticSiteExpanded, UpdateViaIdentityAuthproviderExpanded Aliases: Required: True @@ -238,7 +325,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserArmResource +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserArmResource ## NOTES From abfe5911f14e893b5f6c975e5095227adda48e5c Mon Sep 17 00:00:00 2001 From: Qi Pan <43341456+Pan-Qi@users.noreply.github.com> Date: Wed, 30 Jul 2025 18:11:47 +1000 Subject: [PATCH 3/7] fix directive --- .../Properties/AssemblyInfo.cs | 1 - src/Websites/Websites.Autorest/README.md | 14 +++++- .../docs/New-AzStaticWebAppBuildAppSetting.md | 27 ++-------- ...w-AzStaticWebAppBuildFunctionAppSetting.md | 27 ++-------- .../docs/New-AzStaticWebAppCustomDomain.md | 27 ++-------- .../New-AzStaticWebAppFunctionAppSetting.md | 33 ++---------- .../docs/New-AzStaticWebAppSetting.md | 33 ++---------- ...ew-AzStaticWebAppUserRoleInvitationLink.md | 42 ++++------------ .../docs/Test-AzStaticWebAppCustomDomain.md | 27 +++------- .../Websites.Autorest/generate-info.json | 2 +- src/Websites/Websites.sln | 28 +++++------ .../help/New-AzStaticWebAppBuildAppSetting.md | 27 ++-------- ...w-AzStaticWebAppBuildFunctionAppSetting.md | 28 ++--------- .../help/New-AzStaticWebAppCustomDomain.md | 28 ++--------- .../New-AzStaticWebAppFunctionAppSetting.md | 40 +++------------ .../help/New-AzStaticWebAppSetting.md | 41 ++++----------- ...ew-AzStaticWebAppUserRoleInvitationLink.md | 50 +++++-------------- .../help/Test-AzStaticWebAppCustomDomain.md | 29 +++-------- 18 files changed, 107 insertions(+), 397 deletions(-) diff --git a/src/Websites/Websites.Autorest/Properties/AssemblyInfo.cs b/src/Websites/Websites.Autorest/Properties/AssemblyInfo.cs index bb44d33738cd..7233f09d2463 100644 --- a/src/Websites/Websites.Autorest/Properties/AssemblyInfo.cs +++ b/src/Websites/Websites.Autorest/Properties/AssemblyInfo.cs @@ -24,4 +24,3 @@ [assembly: System.Reflection.AssemblyVersionAttribute("3.4.1")] [assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] [assembly: System.CLSCompliantAttribute(false)] - diff --git a/src/Websites/Websites.Autorest/README.md b/src/Websites/Websites.Autorest/README.md index b44f82be5420..84d0fa553b32 100644 --- a/src/Websites/Websites.Autorest/README.md +++ b/src/Websites/Websites.Autorest/README.md @@ -199,8 +199,20 @@ directive: verb: Unregister subject: BuildUserProvidedFunctionApp + # Remove variant + # Following is two common directive which are normally required in all the RPs + # 1. Remove the unexpanded parameter set + # 2. For New-* cmdlets, ViaIdentity is not required, so CreateViaIdentityExpanded is removed as well - where: - variant: ^(Create|Update)(?!.*?(Expanded|JsonFilePath|JsonString)) + variant: ^(Create|Update)(?!.*?(Expanded|JsonFilePath|JsonString))|^CreateViaIdentityExpanded$ + remove: true + + - where: + verb: Test + variant: ^Validate$|^ValidateViaIdentity$ + # We got to keep the Create variant of CustomDomain because it's special that it doesn't have a + # CreateExpanded variant, because the only parameters are all in URL rather than request body + subject: CustomDomain remove: true - where: diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md index 277be770c32d..540020767c8c 100644 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md @@ -19,12 +19,6 @@ New-AzStaticWebAppBuildAppSetting -EnvironmentName -Name -Reso [-WhatIf] [] ``` -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppBuildAppSetting -InputObject [-AppSetting ] [-Kind ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - ### CreateViaIdentityStaticSiteExpanded ``` New-AzStaticWebAppBuildAppSetting -EnvironmentName -StaticSiteInputObject @@ -84,7 +78,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False @@ -115,7 +109,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: (All) Aliases: Required: True @@ -125,21 +119,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -JsonFilePath Path of Json file supplied to the Create operation @@ -175,7 +154,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md index 36fce356c969..d430d3124ebc 100644 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md @@ -19,12 +19,6 @@ New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -Name ] ``` -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppBuildFunctionAppSetting -InputObject [-AppSetting ] - [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - ### CreateViaIdentityStaticSiteExpanded ``` New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -StaticSiteInputObject @@ -84,7 +78,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False @@ -115,7 +109,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: (All) Aliases: Required: True @@ -125,21 +119,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -JsonFilePath Path of Json file supplied to the Create operation @@ -175,7 +154,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppCustomDomain.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppCustomDomain.md index 1d638b03b059..f6d47f76e535 100644 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppCustomDomain.md +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppCustomDomain.md @@ -19,12 +19,6 @@ New-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGrou [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppCustomDomain -InputObject [-Kind ] [-ValidationMethod ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - ### CreateViaIdentityStaticSiteExpanded ``` New-AzStaticWebAppCustomDomain -DomainName -StaticSiteInputObject @@ -103,7 +97,7 @@ The custom domain to create. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: (All) Aliases: Required: True @@ -113,21 +107,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -JsonFilePath Path of Json file supplied to the Create operation @@ -163,7 +142,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False @@ -255,7 +234,7 @@ Validation method for adding a custom domain ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md index b5a21e3f32e9..322eec2b0e90 100644 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md @@ -19,12 +19,6 @@ New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [] ``` -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppFunctionAppSetting -InputObject [-AppSetting ] - [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - ### CreateViaJsonFilePath ``` New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName -JsonFilePath @@ -75,7 +69,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -101,21 +95,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -JsonFilePath Path of Json file supplied to the Create operation @@ -151,7 +130,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -166,7 +145,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: (All) Aliases: Required: True @@ -181,7 +160,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: (All) Aliases: Required: True @@ -198,7 +177,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: (All) Aliases: Required: False @@ -244,8 +223,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md index f0bab285488d..757e4cc18b2a 100644 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md @@ -19,12 +19,6 @@ New-AzStaticWebAppSetting -Name -ResourceGroupName [-Subscript [] ``` -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppSetting -InputObject [-AppSetting ] [-Kind ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - ### CreateViaJsonFilePath ``` New-AzStaticWebAppSetting -Name -ResourceGroupName -JsonFilePath @@ -75,7 +69,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -101,21 +95,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -JsonFilePath Path of Json file supplied to the Create operation @@ -151,7 +130,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -166,7 +145,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: (All) Aliases: Required: True @@ -181,7 +160,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: (All) Aliases: Required: True @@ -198,7 +177,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: (All) Aliases: Required: False @@ -244,8 +223,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md index 8587753feb44..340ff708b7a1 100644 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md @@ -19,13 +19,6 @@ New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppUserRoleInvitationLink -InputObject [-Domain ] [-Kind ] - [-NumHoursToExpiration ] [-Provider ] [-Role ] [-UserDetail ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - ### CreateViaJsonFilePath ``` New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName -JsonFilePath @@ -88,7 +81,7 @@ The domain name for the static site custom domain. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -98,21 +91,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -JsonFilePath Path of Json file supplied to the Create operation @@ -148,7 +126,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -163,7 +141,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: (All) Aliases: Required: True @@ -178,7 +156,7 @@ The number of hours the sas token stays valid ```yaml Type: System.Int32 -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -193,7 +171,7 @@ The identity provider for the static site user. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -208,7 +186,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: (All) Aliases: Required: True @@ -223,7 +201,7 @@ The roles for the static site user, in free-form string format ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -240,7 +218,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: (All) Aliases: Required: False @@ -255,7 +233,7 @@ The user id for the static site user. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -301,8 +279,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserInvitationResponseResource diff --git a/src/Websites/Websites.Autorest/docs/Test-AzStaticWebAppCustomDomain.md b/src/Websites/Websites.Autorest/docs/Test-AzStaticWebAppCustomDomain.md index fbbb16c60e2d..0493a6396cb0 100644 --- a/src/Websites/Websites.Autorest/docs/Test-AzStaticWebAppCustomDomain.md +++ b/src/Websites/Websites.Autorest/docs/Test-AzStaticWebAppCustomDomain.md @@ -19,21 +19,6 @@ Test-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGro [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] ``` -### Validate -``` -Test-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName - -StaticSiteCustomDomainRequestPropertiesEnvelope - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### ValidateViaIdentity -``` -Test-AzStaticWebAppCustomDomain -InputObject - -StaticSiteCustomDomainRequestPropertiesEnvelope - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - ### ValidateViaIdentityExpanded ``` Test-AzStaticWebAppCustomDomain -InputObject [-Kind ] [-ValidationMethod ] @@ -127,7 +112,7 @@ The custom domain to validate. ```yaml Type: System.String -Parameter Sets: Validate, ValidateExpanded, ValidateViaIdentityStaticSite, ValidateViaIdentityStaticSiteExpanded, ValidateViaJsonFilePath, ValidateViaJsonString +Parameter Sets: ValidateExpanded, ValidateViaIdentityStaticSite, ValidateViaIdentityStaticSiteExpanded, ValidateViaJsonFilePath, ValidateViaJsonString Aliases: Required: True @@ -142,7 +127,7 @@ Identity Parameter ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: ValidateViaIdentity, ValidateViaIdentityExpanded +Parameter Sets: ValidateViaIdentityExpanded Aliases: Required: True @@ -202,7 +187,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: Validate, ValidateExpanded, ValidateViaJsonFilePath, ValidateViaJsonString +Parameter Sets: ValidateExpanded, ValidateViaJsonFilePath, ValidateViaJsonString Aliases: Required: True @@ -247,7 +232,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: Validate, ValidateExpanded, ValidateViaJsonFilePath, ValidateViaJsonString +Parameter Sets: ValidateExpanded, ValidateViaJsonFilePath, ValidateViaJsonString Aliases: Required: True @@ -262,7 +247,7 @@ Static Site Custom Domain Request Properties ARM resource. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteCustomDomainRequestPropertiesArmResource -Parameter Sets: Validate, ValidateViaIdentity, ValidateViaIdentityStaticSite +Parameter Sets: ValidateViaIdentityStaticSite Aliases: Required: True @@ -294,7 +279,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: Validate, ValidateExpanded, ValidateViaJsonFilePath, ValidateViaJsonString +Parameter Sets: ValidateExpanded, ValidateViaJsonFilePath, ValidateViaJsonString Aliases: Required: False diff --git a/src/Websites/Websites.Autorest/generate-info.json b/src/Websites/Websites.Autorest/generate-info.json index 781c2552d0c9..43e6145e914c 100644 --- a/src/Websites/Websites.Autorest/generate-info.json +++ b/src/Websites/Websites.Autorest/generate-info.json @@ -1,3 +1,3 @@ { - "generate_Id": "125ff24d-ad9d-40cc-8315-6ec9bc495e35" + "generate_Id": "37fcff03-3e91-4ae5-8d70-e9b2c121d7a4" } diff --git a/src/Websites/Websites.sln b/src/Websites/Websites.sln index 2c464b90461a..a35efdf88167 100644 --- a/src/Websites/Websites.sln +++ b/src/Websites/Websites.sln @@ -35,7 +35,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestFx", "..\..\tools\TestF EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Websites.Autorest", "Websites.Autorest", "{900AEDEE-C556-8DEE-573E-ADA5C00E8E41}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Websites", "..\..\generated\Websites\Websites.Autorest\Az.Websites.csproj", "{877240F5-C957-4436-858D-1AD0FA85DCFE}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Websites", "..\..\generated\Websites\Websites.Autorest\Az.Websites.csproj", "{654BC6B0-0D19-499B-9E0D-85F758048846}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -191,18 +191,18 @@ Global {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Release|x64.Build.0 = Release|Any CPU {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Release|x86.ActiveCfg = Release|Any CPU {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Release|x86.Build.0 = Release|Any CPU - {877240F5-C957-4436-858D-1AD0FA85DCFE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {877240F5-C957-4436-858D-1AD0FA85DCFE}.Debug|Any CPU.Build.0 = Debug|Any CPU - {877240F5-C957-4436-858D-1AD0FA85DCFE}.Debug|x64.ActiveCfg = Debug|Any CPU - {877240F5-C957-4436-858D-1AD0FA85DCFE}.Debug|x64.Build.0 = Debug|Any CPU - {877240F5-C957-4436-858D-1AD0FA85DCFE}.Debug|x86.ActiveCfg = Debug|Any CPU - {877240F5-C957-4436-858D-1AD0FA85DCFE}.Debug|x86.Build.0 = Debug|Any CPU - {877240F5-C957-4436-858D-1AD0FA85DCFE}.Release|Any CPU.ActiveCfg = Release|Any CPU - {877240F5-C957-4436-858D-1AD0FA85DCFE}.Release|Any CPU.Build.0 = Release|Any CPU - {877240F5-C957-4436-858D-1AD0FA85DCFE}.Release|x64.ActiveCfg = Release|Any CPU - {877240F5-C957-4436-858D-1AD0FA85DCFE}.Release|x64.Build.0 = Release|Any CPU - {877240F5-C957-4436-858D-1AD0FA85DCFE}.Release|x86.ActiveCfg = Release|Any CPU - {877240F5-C957-4436-858D-1AD0FA85DCFE}.Release|x86.Build.0 = Release|Any CPU + {654BC6B0-0D19-499B-9E0D-85F758048846}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {654BC6B0-0D19-499B-9E0D-85F758048846}.Debug|Any CPU.Build.0 = Debug|Any CPU + {654BC6B0-0D19-499B-9E0D-85F758048846}.Debug|x64.ActiveCfg = Debug|Any CPU + {654BC6B0-0D19-499B-9E0D-85F758048846}.Debug|x64.Build.0 = Debug|Any CPU + {654BC6B0-0D19-499B-9E0D-85F758048846}.Debug|x86.ActiveCfg = Debug|Any CPU + {654BC6B0-0D19-499B-9E0D-85F758048846}.Debug|x86.Build.0 = Debug|Any CPU + {654BC6B0-0D19-499B-9E0D-85F758048846}.Release|Any CPU.ActiveCfg = Release|Any CPU + {654BC6B0-0D19-499B-9E0D-85F758048846}.Release|Any CPU.Build.0 = Release|Any CPU + {654BC6B0-0D19-499B-9E0D-85F758048846}.Release|x64.ActiveCfg = Release|Any CPU + {654BC6B0-0D19-499B-9E0D-85F758048846}.Release|x64.Build.0 = Release|Any CPU + {654BC6B0-0D19-499B-9E0D-85F758048846}.Release|x86.ActiveCfg = Release|Any CPU + {654BC6B0-0D19-499B-9E0D-85F758048846}.Release|x86.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -219,6 +219,6 @@ Global {A2A07768-727E-44A6-91A0-8DFC18B3A21C} = {4B610034-1263-4F14-8AA5-E2EB60BA7015} {BE011844-9309-4A55-BA04-FD41DF8F2700} = {EE35FE1C-D292-4F41-BD5C-3EAC5A7D3211} {A3FBC234-434F-4C1C-9721-D55C14E6CF59} = {EE35FE1C-D292-4F41-BD5C-3EAC5A7D3211} - {877240F5-C957-4436-858D-1AD0FA85DCFE} = {900AEDEE-C556-8DEE-573E-ADA5C00E8E41} + {654BC6B0-0D19-499B-9E0D-85F758048846} = {900AEDEE-C556-8DEE-573E-ADA5C00E8E41} EndGlobalSection EndGlobal diff --git a/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md b/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md index 6f8af86017f0..b5a476959cbc 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md @@ -40,12 +40,6 @@ New-AzStaticWebAppBuildAppSetting -EnvironmentName -StaticSiteInputObje [-WhatIf] [-Confirm] [] ``` -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppBuildAppSetting -InputObject [-AppSetting ] [-Kind ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - ## DESCRIPTION Description for create the app settings of a static site build. @@ -84,7 +78,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False @@ -115,7 +109,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, CreateViaIdentityStaticSiteExpanded +Parameter Sets: (All) Aliases: Required: True @@ -125,21 +119,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -JsonFilePath Path of Json file supplied to the Create operation @@ -175,7 +154,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False diff --git a/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md b/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md index 04e9681cebd1..104d8a20d6ca 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md @@ -40,13 +40,6 @@ New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -StaticSiteI [-WhatIf] [-Confirm] [] ``` -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppBuildFunctionAppSetting -InputObject [-AppSetting ] - [-Kind ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - ## DESCRIPTION Description for create the function app settings of a static site build. @@ -85,7 +78,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False @@ -116,7 +109,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, CreateViaIdentityStaticSiteExpanded +Parameter Sets: (All) Aliases: Required: True @@ -126,21 +119,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -JsonFilePath Path of Json file supplied to the Create operation @@ -176,7 +154,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False diff --git a/src/Websites/Websites/help/New-AzStaticWebAppCustomDomain.md b/src/Websites/Websites/help/New-AzStaticWebAppCustomDomain.md index 31c431fe0bfd..793f0024e805 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppCustomDomain.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppCustomDomain.md @@ -40,13 +40,6 @@ New-AzStaticWebAppCustomDomain -DomainName -StaticSiteInputObject ] ``` -### CreateViaIdentityExpanded -``` -New-AzStaticWebAppCustomDomain -InputObject [-Kind ] [-ValidationMethod ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] -``` - ## DESCRIPTION Description for create a new static site custom domain in an existing resource group and static site. @@ -104,7 +97,7 @@ The custom domain to create. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, CreateViaIdentityStaticSiteExpanded +Parameter Sets: (All) Aliases: Required: True @@ -114,21 +107,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -JsonFilePath Path of Json file supplied to the Create operation @@ -164,7 +142,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False @@ -256,7 +234,7 @@ Validation method for adding a custom domain ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False diff --git a/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md b/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md index 769ffd7f164d..7f99be6d4d5f 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md @@ -19,13 +19,6 @@ New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-WhatIf] [-Confirm] [] ``` -### CreateViaJsonString -``` -New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - ### CreateViaJsonFilePath ``` New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-SubscriptionId ] @@ -33,10 +26,10 @@ New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [] ``` -### CreateViaIdentityExpanded +### CreateViaJsonString ``` -New-AzStaticWebAppFunctionAppSetting -InputObject [-AppSetting ] - [-Kind ] [-DefaultProfile ] [-WhatIf] [-Confirm] +New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` @@ -78,7 +71,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -104,21 +97,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -JsonFilePath Path of Json file supplied to the Create operation @@ -154,7 +132,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -169,7 +147,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Parameter Sets: (All) Aliases: Required: True @@ -184,7 +162,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Parameter Sets: (All) Aliases: Required: True @@ -201,7 +179,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Parameter Sets: (All) Aliases: Required: False @@ -247,8 +225,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary diff --git a/src/Websites/Websites/help/New-AzStaticWebAppSetting.md b/src/Websites/Websites/help/New-AzStaticWebAppSetting.md index 6edd03a6c45b..2de066a59b59 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppSetting.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppSetting.md @@ -19,13 +19,6 @@ New-AzStaticWebAppSetting -Name -ResourceGroupName [-Subscript [-WhatIf] [-Confirm] [] ``` -### CreateViaJsonString -``` -New-AzStaticWebAppSetting -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - ### CreateViaJsonFilePath ``` New-AzStaticWebAppSetting -Name -ResourceGroupName [-SubscriptionId ] @@ -33,10 +26,11 @@ New-AzStaticWebAppSetting -Name -ResourceGroupName [-Subscript [] ``` -### CreateViaIdentityExpanded +### CreateViaJsonString ``` -New-AzStaticWebAppSetting -InputObject [-AppSetting ] [-Kind ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] +New-AzStaticWebAppSetting -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -77,7 +71,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -103,21 +97,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -JsonFilePath Path of Json file supplied to the Create operation @@ -153,7 +132,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -168,7 +147,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Parameter Sets: (All) Aliases: Required: True @@ -183,7 +162,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Parameter Sets: (All) Aliases: Required: True @@ -200,7 +179,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Parameter Sets: (All) Aliases: Required: False @@ -246,8 +225,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary diff --git a/src/Websites/Websites/help/New-AzStaticWebAppUserRoleInvitationLink.md b/src/Websites/Websites/help/New-AzStaticWebAppUserRoleInvitationLink.md index 38edf99d8d95..0ad69e27157a 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppUserRoleInvitationLink.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppUserRoleInvitationLink.md @@ -20,13 +20,6 @@ New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName ] ``` -### CreateViaJsonString -``` -New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - ### CreateViaJsonFilePath ``` New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName [-SubscriptionId ] @@ -34,11 +27,11 @@ New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName ] ``` -### CreateViaIdentityExpanded +### CreateViaJsonString ``` -New-AzStaticWebAppUserRoleInvitationLink -InputObject [-Domain ] [-Kind ] - [-NumHoursToExpiration ] [-Provider ] [-Role ] [-UserDetail ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] +New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -90,7 +83,7 @@ The domain name for the static site custom domain. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -100,21 +93,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -JsonFilePath Path of Json file supplied to the Create operation @@ -150,7 +128,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -165,7 +143,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Parameter Sets: (All) Aliases: Required: True @@ -180,7 +158,7 @@ The number of hours the sas token stays valid ```yaml Type: System.Int32 -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -195,7 +173,7 @@ The identity provider for the static site user. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -210,7 +188,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Parameter Sets: (All) Aliases: Required: True @@ -225,7 +203,7 @@ The roles for the static site user, in free-form string format ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -242,7 +220,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Parameter Sets: (All) Aliases: Required: False @@ -257,7 +235,7 @@ The user id for the static site user. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Parameter Sets: CreateExpanded Aliases: Required: False @@ -303,8 +281,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity - ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserInvitationResponseResource diff --git a/src/Websites/Websites/help/Test-AzStaticWebAppCustomDomain.md b/src/Websites/Websites/help/Test-AzStaticWebAppCustomDomain.md index 79b69865b004..30e54ae6f75e 100644 --- a/src/Websites/Websites/help/Test-AzStaticWebAppCustomDomain.md +++ b/src/Websites/Websites/help/Test-AzStaticWebAppCustomDomain.md @@ -48,15 +48,6 @@ Test-AzStaticWebAppCustomDomain -DomainName -StaticSiteInputObject ] ``` -### Validate -``` -Test-AzStaticWebAppCustomDomain -DomainName -Name -ResourceGroupName - [-SubscriptionId ] - -StaticSiteCustomDomainRequestPropertiesEnvelope - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] - [-Confirm] [] -``` - ### ValidateViaIdentityExpanded ``` Test-AzStaticWebAppCustomDomain -InputObject [-Kind ] [-ValidationMethod ] @@ -64,14 +55,6 @@ Test-AzStaticWebAppCustomDomain -InputObject [-Kind [-Confirm] [] ``` -### ValidateViaIdentity -``` -Test-AzStaticWebAppCustomDomain -InputObject - -StaticSiteCustomDomainRequestPropertiesEnvelope - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] - [-Confirm] [] -``` - ## DESCRIPTION Description for Validates a particular custom domain can be added to a static site. @@ -129,7 +112,7 @@ The custom domain to validate. ```yaml Type: System.String -Parameter Sets: ValidateExpanded, ValidateViaJsonString, ValidateViaJsonFilePath, ValidateViaIdentityStaticSiteExpanded, ValidateViaIdentityStaticSite, Validate +Parameter Sets: ValidateExpanded, ValidateViaJsonString, ValidateViaJsonFilePath, ValidateViaIdentityStaticSiteExpanded, ValidateViaIdentityStaticSite Aliases: Required: True @@ -144,7 +127,7 @@ Identity Parameter ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: ValidateViaIdentityExpanded, ValidateViaIdentity +Parameter Sets: ValidateViaIdentityExpanded Aliases: Required: True @@ -204,7 +187,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: ValidateExpanded, ValidateViaJsonString, ValidateViaJsonFilePath, Validate +Parameter Sets: ValidateExpanded, ValidateViaJsonString, ValidateViaJsonFilePath Aliases: Required: True @@ -249,7 +232,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: ValidateExpanded, ValidateViaJsonString, ValidateViaJsonFilePath, Validate +Parameter Sets: ValidateExpanded, ValidateViaJsonString, ValidateViaJsonFilePath Aliases: Required: True @@ -264,7 +247,7 @@ Static Site Custom Domain Request Properties ARM resource. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteCustomDomainRequestPropertiesArmResource -Parameter Sets: ValidateViaIdentityStaticSite, Validate, ValidateViaIdentity +Parameter Sets: ValidateViaIdentityStaticSite Aliases: Required: True @@ -296,7 +279,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: ValidateExpanded, ValidateViaJsonString, ValidateViaJsonFilePath, Validate +Parameter Sets: ValidateExpanded, ValidateViaJsonString, ValidateViaJsonFilePath Aliases: Required: False From 345bc0fdf0ca5a3643b4dc41d6a0b8ce1543a6de Mon Sep 17 00:00:00 2001 From: Qi Pan <43341456+Pan-Qi@users.noreply.github.com> Date: Thu, 31 Jul 2025 00:29:12 +1000 Subject: [PATCH 4/7] fix directive & add changelog --- src/Websites/Websites.Autorest/README.md | 24 +- .../docs/New-AzStaticWebAppBuildAppSetting.md | 27 ++- ...w-AzStaticWebAppBuildFunctionAppSetting.md | 27 ++- .../New-AzStaticWebAppFunctionAppSetting.md | 33 ++- .../docs/New-AzStaticWebAppSetting.md | 33 ++- ...ew-AzStaticWebAppUserRoleInvitationLink.md | 42 +++- ...r-AzStaticWebAppUserProvidedFunctionApp.md | 183 +++++++++++++++- .../docs/Update-AzStaticWebAppUser.md | 39 +++- .../Websites.Autorest/generate-info.json | 2 +- src/Websites/Websites.sln | 28 +-- src/Websites/Websites/Az.Websites.psd1 | 2 +- src/Websites/Websites/ChangeLog.md | 5 + .../help/New-AzStaticWebAppBuildAppSetting.md | 27 ++- ...w-AzStaticWebAppBuildFunctionAppSetting.md | 28 ++- .../New-AzStaticWebAppFunctionAppSetting.md | 40 +++- .../help/New-AzStaticWebAppSetting.md | 41 +++- ...ew-AzStaticWebAppUserRoleInvitationLink.md | 50 +++-- ...r-AzStaticWebAppUserProvidedFunctionApp.md | 205 ++++++++++++++++-- .../help/Update-AzStaticWebAppUser.md | 39 +++- 19 files changed, 767 insertions(+), 108 deletions(-) diff --git a/src/Websites/Websites.Autorest/README.md b/src/Websites/Websites.Autorest/README.md index 84d0fa553b32..181ce280b3a6 100644 --- a/src/Websites/Websites.Autorest/README.md +++ b/src/Websites/Websites.Autorest/README.md @@ -204,7 +204,27 @@ directive: # 1. Remove the unexpanded parameter set # 2. For New-* cmdlets, ViaIdentity is not required, so CreateViaIdentityExpanded is removed as well - where: - variant: ^(Create|Update)(?!.*?(Expanded|JsonFilePath|JsonString))|^CreateViaIdentityExpanded$ + subject: CustomDomain|BuildAppSetting|FunctionAppSetting|Setting|BuildFunctionAppSetting|UserRoleInvitationLink + variant: ^Create(?!.*?(Expanded|JsonFilePath|JsonString)) + remove: true + + - where: + variant: ^CreateViaIdentityExpanded$ + # We got to keep the Create variant of CustomDomain because it's special that it doesn't have a + # CreateExpanded variant, because the only parameters are all in URL rather than request body + subject: CustomDomain + remove: true + + - where: + verb: New + subject: ^$ + variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$ + remove: true + + - where: + verb: Update + subject: null + variant: ^Update$|^UpdateViaIdentity$ remove: true - where: @@ -224,7 +244,7 @@ directive: - where: verb: Register subject: UserProvidedFunctionApp - variant: ^Register(?!.*?(JsonFilePath|JsonString)) + variant: ^Register$|^Register1$|^RegisterViaIdentity$|^RegisterViaIdentity1$|^RegisterViaIdentityExpanded$|^RegisterViaIdentityExpanded1$ remove: true # Rename parameters diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md index 540020767c8c..277be770c32d 100644 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildAppSetting.md @@ -19,6 +19,12 @@ New-AzStaticWebAppBuildAppSetting -EnvironmentName -Name -Reso [-WhatIf] [] ``` +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppBuildAppSetting -InputObject [-AppSetting ] [-Kind ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ### CreateViaIdentityStaticSiteExpanded ``` New-AzStaticWebAppBuildAppSetting -EnvironmentName -StaticSiteInputObject @@ -78,7 +84,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False @@ -109,7 +115,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -119,6 +125,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -JsonFilePath Path of Json file supplied to the Create operation @@ -154,7 +175,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md index d430d3124ebc..36fce356c969 100644 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppBuildFunctionAppSetting.md @@ -19,6 +19,12 @@ New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -Name ] ``` +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppBuildFunctionAppSetting -InputObject [-AppSetting ] + [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ### CreateViaIdentityStaticSiteExpanded ``` New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -StaticSiteInputObject @@ -78,7 +84,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False @@ -109,7 +115,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -119,6 +125,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -JsonFilePath Path of Json file supplied to the Create operation @@ -154,7 +175,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityStaticSiteExpanded Aliases: Required: False diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md index 322eec2b0e90..b5a21e3f32e9 100644 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppFunctionAppSetting.md @@ -19,6 +19,12 @@ New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [] ``` +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppFunctionAppSetting -InputObject [-AppSetting ] + [-Kind ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ### CreateViaJsonFilePath ``` New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName -JsonFilePath @@ -69,7 +75,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -95,6 +101,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -JsonFilePath Path of Json file supplied to the Create operation @@ -130,7 +151,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -145,7 +166,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -160,7 +181,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -177,7 +198,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: False @@ -223,6 +244,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md index 757e4cc18b2a..f0bab285488d 100644 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppSetting.md @@ -19,6 +19,12 @@ New-AzStaticWebAppSetting -Name -ResourceGroupName [-Subscript [] ``` +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppSetting -InputObject [-AppSetting ] [-Kind ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ### CreateViaJsonFilePath ``` New-AzStaticWebAppSetting -Name -ResourceGroupName -JsonFilePath @@ -69,7 +75,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -95,6 +101,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -JsonFilePath Path of Json file supplied to the Create operation @@ -130,7 +151,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -145,7 +166,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -160,7 +181,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -177,7 +198,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: False @@ -223,6 +244,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary diff --git a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md index 340ff708b7a1..8587753feb44 100644 --- a/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md +++ b/src/Websites/Websites.Autorest/docs/New-AzStaticWebAppUserRoleInvitationLink.md @@ -19,6 +19,13 @@ New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppUserRoleInvitationLink -InputObject [-Domain ] [-Kind ] + [-NumHoursToExpiration ] [-Provider ] [-Role ] [-UserDetail ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ### CreateViaJsonFilePath ``` New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName -JsonFilePath @@ -81,7 +88,7 @@ The domain name for the static site custom domain. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -91,6 +98,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -JsonFilePath Path of Json file supplied to the Create operation @@ -126,7 +148,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -141,7 +163,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -156,7 +178,7 @@ The number of hours the sas token stays valid ```yaml Type: System.Int32 -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -171,7 +193,7 @@ The identity provider for the static site user. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -186,7 +208,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -201,7 +223,7 @@ The roles for the static site user, in free-form string format ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -218,7 +240,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: False @@ -233,7 +255,7 @@ The user id for the static site user. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -279,6 +301,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserInvitationResponseResource diff --git a/src/Websites/Websites.Autorest/docs/Register-AzStaticWebAppUserProvidedFunctionApp.md b/src/Websites/Websites.Autorest/docs/Register-AzStaticWebAppUserProvidedFunctionApp.md index 357fb4bb927b..34da82649ad4 100644 --- a/src/Websites/Websites.Autorest/docs/Register-AzStaticWebAppUserProvidedFunctionApp.md +++ b/src/Websites/Websites.Autorest/docs/Register-AzStaticWebAppUserProvidedFunctionApp.md @@ -12,13 +12,68 @@ Description for Register a user provided function app with a static site build ## SYNTAX -### RegisterViaJsonFilePath1 (Default) +### RegisterExpanded1 (Default) ``` Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name - -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-Forced] + -ResourceGroupName [-SubscriptionId ] [-Forced] [-FunctionAppRegion ] + [-FunctionAppResourceId ] [-Kind ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### RegisterExpanded +``` +Register-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -FunctionAppName + -Name -ResourceGroupName [-SubscriptionId ] [-Forced] [-FunctionAppRegion ] + [-FunctionAppResourceId ] [-Kind ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### RegisterViaIdentityBuild +``` +Register-AzStaticWebAppUserProvidedFunctionApp -BuildInputObject -FunctionAppName + -StaticSiteUserProvidedFunctionEnvelope [-Forced] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` +### RegisterViaIdentityBuildExpanded +``` +Register-AzStaticWebAppUserProvidedFunctionApp -BuildInputObject -FunctionAppName + [-Forced] [-FunctionAppRegion ] [-FunctionAppResourceId ] [-Kind ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### RegisterViaIdentityStaticSite +``` +Register-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -FunctionAppName + -StaticSiteInputObject + -StaticSiteUserProvidedFunctionEnvelope [-Forced] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### RegisterViaIdentityStaticSite1 +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName + -StaticSite1InputObject + -StaticSiteUserProvidedFunctionEnvelope [-Forced] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### RegisterViaIdentityStaticSiteExpanded +``` +Register-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -FunctionAppName + -StaticSiteInputObject [-Forced] [-FunctionAppRegion ] + [-FunctionAppResourceId ] [-Kind ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### RegisterViaIdentityStaticSiteExpanded1 +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName + -StaticSiteInputObject [-Forced] [-FunctionAppRegion ] + [-FunctionAppResourceId ] [-Kind ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + ### RegisterViaJsonFilePath ``` Register-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -FunctionAppName @@ -26,6 +81,13 @@ Register-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -Functi [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` +### RegisterViaJsonFilePath1 +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name + -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-Forced] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + ### RegisterViaJsonString ``` Register-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName -FunctionAppName @@ -90,6 +152,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -BuildInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RegisterViaIdentityBuild, RegisterViaIdentityBuildExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -111,7 +188,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: RegisterViaJsonFilePath, RegisterViaJsonString +Parameter Sets: RegisterExpanded, RegisterViaIdentityStaticSite, RegisterViaIdentityStaticSiteExpanded, RegisterViaJsonFilePath, RegisterViaJsonString Aliases: Required: True @@ -152,6 +229,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FunctionAppRegion +The region of the function app registered with the static site + +```yaml +Type: System.String +Parameter Sets: RegisterExpanded, RegisterExpanded1, RegisterViaIdentityBuildExpanded, RegisterViaIdentityStaticSiteExpanded, RegisterViaIdentityStaticSiteExpanded1 +Aliases: + +Required: False +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 + +```yaml +Type: System.String +Parameter Sets: RegisterExpanded, RegisterExpanded1, RegisterViaIdentityBuildExpanded, RegisterViaIdentityStaticSiteExpanded, RegisterViaIdentityStaticSiteExpanded1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -JsonFilePath Path of Json file supplied to the Register operation @@ -182,12 +289,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: RegisterExpanded, RegisterExpanded1, RegisterViaIdentityBuildExpanded, RegisterViaIdentityStaticSiteExpanded, RegisterViaIdentityStaticSiteExpanded1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Name of the static site. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: RegisterExpanded, RegisterExpanded1, RegisterViaJsonFilePath, RegisterViaJsonFilePath1, RegisterViaJsonString, RegisterViaJsonString1 Aliases: Required: True @@ -217,7 +339,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: RegisterExpanded, RegisterExpanded1, RegisterViaJsonFilePath, RegisterViaJsonFilePath1, RegisterViaJsonString, RegisterViaJsonString1 Aliases: Required: True @@ -227,6 +349,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSite1InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RegisterViaIdentityStaticSite1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RegisterViaIdentityStaticSite, RegisterViaIdentityStaticSiteExpanded, RegisterViaIdentityStaticSiteExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StaticSiteUserProvidedFunctionEnvelope +Static Site User Provided Function App ARM resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionAppArmResource +Parameter Sets: RegisterViaIdentityBuild, RegisterViaIdentityStaticSite, RegisterViaIdentityStaticSite1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. @@ -234,7 +401,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: RegisterExpanded, RegisterExpanded1, RegisterViaJsonFilePath, RegisterViaJsonFilePath1, RegisterViaJsonString, RegisterViaJsonString1 Aliases: Required: False @@ -280,6 +447,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionAppArmResource + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionAppArmResource diff --git a/src/Websites/Websites.Autorest/docs/Update-AzStaticWebAppUser.md b/src/Websites/Websites.Autorest/docs/Update-AzStaticWebAppUser.md index 1ebeb01b078b..0465124635da 100644 --- a/src/Websites/Websites.Autorest/docs/Update-AzStaticWebAppUser.md +++ b/src/Websites/Websites.Autorest/docs/Update-AzStaticWebAppUser.md @@ -19,6 +19,13 @@ Update-AzStaticWebAppUser -AuthProvider -Name -ResourceGroupNa [-WhatIf] [] ``` +### UpdateViaIdentityAuthprovider +``` +Update-AzStaticWebAppUser -AuthproviderInputObject -UserId + -StaticSiteUserEnvelope [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + ### UpdateViaIdentityAuthproviderExpanded ``` Update-AzStaticWebAppUser -AuthproviderInputObject -UserId [-Kind ] @@ -31,6 +38,13 @@ Update-AzStaticWebAppUser -InputObject [-Kind ] [-Ro [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` +### UpdateViaIdentityStaticSite +``` +Update-AzStaticWebAppUser -AuthProvider -StaticSiteInputObject -UserId + -StaticSiteUserEnvelope [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + ### UpdateViaIdentityStaticSiteExpanded ``` Update-AzStaticWebAppUser -AuthProvider -StaticSiteInputObject -UserId @@ -90,7 +104,7 @@ The auth provider for this user. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityStaticSiteExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Parameter Sets: UpdateExpanded, UpdateViaIdentityStaticSite, UpdateViaIdentityStaticSiteExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -105,7 +119,7 @@ Identity Parameter ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: UpdateViaIdentityAuthproviderExpanded +Parameter Sets: UpdateViaIdentityAuthprovider, UpdateViaIdentityAuthproviderExpanded Aliases: Required: True @@ -241,7 +255,22 @@ Identity Parameter ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: UpdateViaIdentityStaticSiteExpanded +Parameter Sets: UpdateViaIdentityStaticSite, UpdateViaIdentityStaticSiteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StaticSiteUserEnvelope +Static Site User ARM resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserArmResource +Parameter Sets: UpdateViaIdentityAuthprovider, UpdateViaIdentityStaticSite Aliases: Required: True @@ -273,7 +302,7 @@ The user id of the user. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityAuthproviderExpanded, UpdateViaIdentityStaticSiteExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Parameter Sets: UpdateExpanded, UpdateViaIdentityAuthprovider, UpdateViaIdentityAuthproviderExpanded, UpdateViaIdentityStaticSite, UpdateViaIdentityStaticSiteExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -319,6 +348,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserArmResource + ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity ## OUTPUTS diff --git a/src/Websites/Websites.Autorest/generate-info.json b/src/Websites/Websites.Autorest/generate-info.json index 43e6145e914c..88a4f24d1f8d 100644 --- a/src/Websites/Websites.Autorest/generate-info.json +++ b/src/Websites/Websites.Autorest/generate-info.json @@ -1,3 +1,3 @@ { - "generate_Id": "37fcff03-3e91-4ae5-8d70-e9b2c121d7a4" + "generate_Id": "8be97281-d8e1-4e67-a408-f3eda4c9a7ae" } diff --git a/src/Websites/Websites.sln b/src/Websites/Websites.sln index a35efdf88167..7d3392c96081 100644 --- a/src/Websites/Websites.sln +++ b/src/Websites/Websites.sln @@ -35,7 +35,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestFx", "..\..\tools\TestF EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Websites.Autorest", "Websites.Autorest", "{900AEDEE-C556-8DEE-573E-ADA5C00E8E41}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Websites", "..\..\generated\Websites\Websites.Autorest\Az.Websites.csproj", "{654BC6B0-0D19-499B-9E0D-85F758048846}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Websites", "..\..\generated\Websites\Websites.Autorest\Az.Websites.csproj", "{C9D5397C-3543-481E-A990-C6298BF6A286}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -191,18 +191,18 @@ Global {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Release|x64.Build.0 = Release|Any CPU {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Release|x86.ActiveCfg = Release|Any CPU {A3FBC234-434F-4C1C-9721-D55C14E6CF59}.Release|x86.Build.0 = Release|Any CPU - {654BC6B0-0D19-499B-9E0D-85F758048846}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {654BC6B0-0D19-499B-9E0D-85F758048846}.Debug|Any CPU.Build.0 = Debug|Any CPU - {654BC6B0-0D19-499B-9E0D-85F758048846}.Debug|x64.ActiveCfg = Debug|Any CPU - {654BC6B0-0D19-499B-9E0D-85F758048846}.Debug|x64.Build.0 = Debug|Any CPU - {654BC6B0-0D19-499B-9E0D-85F758048846}.Debug|x86.ActiveCfg = Debug|Any CPU - {654BC6B0-0D19-499B-9E0D-85F758048846}.Debug|x86.Build.0 = Debug|Any CPU - {654BC6B0-0D19-499B-9E0D-85F758048846}.Release|Any CPU.ActiveCfg = Release|Any CPU - {654BC6B0-0D19-499B-9E0D-85F758048846}.Release|Any CPU.Build.0 = Release|Any CPU - {654BC6B0-0D19-499B-9E0D-85F758048846}.Release|x64.ActiveCfg = Release|Any CPU - {654BC6B0-0D19-499B-9E0D-85F758048846}.Release|x64.Build.0 = Release|Any CPU - {654BC6B0-0D19-499B-9E0D-85F758048846}.Release|x86.ActiveCfg = Release|Any CPU - {654BC6B0-0D19-499B-9E0D-85F758048846}.Release|x86.Build.0 = Release|Any CPU + {C9D5397C-3543-481E-A990-C6298BF6A286}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {C9D5397C-3543-481E-A990-C6298BF6A286}.Debug|Any CPU.Build.0 = Debug|Any CPU + {C9D5397C-3543-481E-A990-C6298BF6A286}.Debug|x64.ActiveCfg = Debug|Any CPU + {C9D5397C-3543-481E-A990-C6298BF6A286}.Debug|x64.Build.0 = Debug|Any CPU + {C9D5397C-3543-481E-A990-C6298BF6A286}.Debug|x86.ActiveCfg = Debug|Any CPU + {C9D5397C-3543-481E-A990-C6298BF6A286}.Debug|x86.Build.0 = Debug|Any CPU + {C9D5397C-3543-481E-A990-C6298BF6A286}.Release|Any CPU.ActiveCfg = Release|Any CPU + {C9D5397C-3543-481E-A990-C6298BF6A286}.Release|Any CPU.Build.0 = Release|Any CPU + {C9D5397C-3543-481E-A990-C6298BF6A286}.Release|x64.ActiveCfg = Release|Any CPU + {C9D5397C-3543-481E-A990-C6298BF6A286}.Release|x64.Build.0 = Release|Any CPU + {C9D5397C-3543-481E-A990-C6298BF6A286}.Release|x86.ActiveCfg = Release|Any CPU + {C9D5397C-3543-481E-A990-C6298BF6A286}.Release|x86.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -219,6 +219,6 @@ Global {A2A07768-727E-44A6-91A0-8DFC18B3A21C} = {4B610034-1263-4F14-8AA5-E2EB60BA7015} {BE011844-9309-4A55-BA04-FD41DF8F2700} = {EE35FE1C-D292-4F41-BD5C-3EAC5A7D3211} {A3FBC234-434F-4C1C-9721-D55C14E6CF59} = {EE35FE1C-D292-4F41-BD5C-3EAC5A7D3211} - {654BC6B0-0D19-499B-9E0D-85F758048846} = {900AEDEE-C556-8DEE-573E-ADA5C00E8E41} + {C9D5397C-3543-481E-A990-C6298BF6A286} = {900AEDEE-C556-8DEE-573E-ADA5C00E8E41} EndGlobalSection EndGlobal diff --git a/src/Websites/Websites/Az.Websites.psd1 b/src/Websites/Websites/Az.Websites.psd1 index 16ac345624e8..eb126534d7d7 100644 --- a/src/Websites/Websites/Az.Websites.psd1 +++ b/src/Websites/Websites/Az.Websites.psd1 @@ -3,7 +3,7 @@ # # Generated by: Microsoft Corporation # -# Generated on: 7/30/2025 +# Generated on: 7/31/2025 # @{ diff --git a/src/Websites/Websites/ChangeLog.md b/src/Websites/Websites/ChangeLog.md index 3b574d42875e..f37a025ed5f2 100644 --- a/src/Websites/Websites/ChangeLog.md +++ b/src/Websites/Websites/ChangeLog.md @@ -18,6 +18,11 @@ - Additional information about change #1 --> ## Upcoming Release +* Introduced various new features by upgrading code generator. Please see details [here](https://github.com/Azure/azure-powershell/blob/main/documentation/Autorest-powershell-v4-new-features.md). +* The parameters of the `New-AzStaticWebApp` cmdlet will be changed by new Managed Identity settings. + - Removed `-IdentityType` and `-IdentityUserAssignedIdentity` parameters. + - Added `-UserAssignedIdentity` parameter. The type of `UserAssignedIdentity` is simplified to a list of strings that is used to specify the user's assigned identity. + - Added `EnableSystemAssignedIdentity` to enable/disable system-assigned identities. ## Version 3.4.1 * Added AppServicePlan management support for Pv4 and Pmv4 tiers. diff --git a/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md b/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md index b5a476959cbc..6f8af86017f0 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md @@ -40,6 +40,12 @@ New-AzStaticWebAppBuildAppSetting -EnvironmentName -StaticSiteInputObje [-WhatIf] [-Confirm] [] ``` +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppBuildAppSetting -InputObject [-AppSetting ] [-Kind ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + ## DESCRIPTION Description for create the app settings of a static site build. @@ -78,7 +84,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -109,7 +115,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, CreateViaIdentityStaticSiteExpanded Aliases: Required: True @@ -119,6 +125,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -JsonFilePath Path of Json file supplied to the Create operation @@ -154,7 +175,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded Aliases: Required: False diff --git a/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md b/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md index 104d8a20d6ca..04e9681cebd1 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md @@ -40,6 +40,13 @@ New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName -StaticSiteI [-WhatIf] [-Confirm] [] ``` +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppBuildFunctionAppSetting -InputObject [-AppSetting ] + [-Kind ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + ## DESCRIPTION Description for create the function app settings of a static site build. @@ -78,7 +85,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -109,7 +116,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, CreateViaIdentityStaticSiteExpanded Aliases: Required: True @@ -119,6 +126,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -JsonFilePath Path of Json file supplied to the Create operation @@ -154,7 +176,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityStaticSiteExpanded, CreateViaIdentityExpanded Aliases: Required: False diff --git a/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md b/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md index 7f99be6d4d5f..769ffd7f164d 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md @@ -19,6 +19,13 @@ New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-WhatIf] [-Confirm] [] ``` +### CreateViaJsonString +``` +New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + ### CreateViaJsonFilePath ``` New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-SubscriptionId ] @@ -26,10 +33,10 @@ New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [] ``` -### CreateViaJsonString +### CreateViaIdentityExpanded ``` -New-AzStaticWebAppFunctionAppSetting -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] +New-AzStaticWebAppFunctionAppSetting -InputObject [-AppSetting ] + [-Kind ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` @@ -71,7 +78,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -97,6 +104,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -JsonFilePath Path of Json file supplied to the Create operation @@ -132,7 +154,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -147,7 +169,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -162,7 +184,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -179,7 +201,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False @@ -225,6 +247,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary diff --git a/src/Websites/Websites/help/New-AzStaticWebAppSetting.md b/src/Websites/Websites/help/New-AzStaticWebAppSetting.md index 2de066a59b59..6edd03a6c45b 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppSetting.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppSetting.md @@ -19,20 +19,26 @@ New-AzStaticWebAppSetting -Name -ResourceGroupName [-Subscript [-WhatIf] [-Confirm] [] ``` -### CreateViaJsonFilePath +### CreateViaJsonString ``` New-AzStaticWebAppSetting -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` -### CreateViaJsonString +### CreateViaJsonFilePath ``` New-AzStaticWebAppSetting -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppSetting -InputObject [-AppSetting ] [-Kind ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + ## DESCRIPTION Description for create the app settings of a static site. @@ -71,7 +77,7 @@ Settings. ```yaml Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -97,6 +103,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -JsonFilePath Path of Json file supplied to the Create operation @@ -132,7 +153,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -147,7 +168,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -162,7 +183,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -179,7 +200,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False @@ -225,6 +246,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStringDictionary diff --git a/src/Websites/Websites/help/New-AzStaticWebAppUserRoleInvitationLink.md b/src/Websites/Websites/help/New-AzStaticWebAppUserRoleInvitationLink.md index 0ad69e27157a..38edf99d8d95 100644 --- a/src/Websites/Websites/help/New-AzStaticWebAppUserRoleInvitationLink.md +++ b/src/Websites/Websites/help/New-AzStaticWebAppUserRoleInvitationLink.md @@ -20,20 +20,27 @@ New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName ] ``` -### CreateViaJsonFilePath +### CreateViaJsonString ``` New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` -### CreateViaJsonString +### CreateViaJsonFilePath ``` New-AzStaticWebAppUserRoleInvitationLink -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppUserRoleInvitationLink -InputObject [-Domain ] [-Kind ] + [-NumHoursToExpiration ] [-Provider ] [-Role ] [-UserDetail ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + ## DESCRIPTION Description for create an invitation link for a user with the role @@ -83,7 +90,7 @@ The domain name for the static site custom domain. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -93,6 +100,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -JsonFilePath Path of Json file supplied to the Create operation @@ -128,7 +150,7 @@ Kind of resource. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -143,7 +165,7 @@ Name of the static site. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -158,7 +180,7 @@ The number of hours the sas token stays valid ```yaml Type: System.Int32 -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -173,7 +195,7 @@ The identity provider for the static site user. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -188,7 +210,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -203,7 +225,7 @@ The roles for the static site user, in free-form string format ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -220,7 +242,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False @@ -235,7 +257,7 @@ The user id for the static site user. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: Required: False @@ -281,6 +303,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserInvitationResponseResource diff --git a/src/Websites/Websites/help/Register-AzStaticWebAppUserProvidedFunctionApp.md b/src/Websites/Websites/help/Register-AzStaticWebAppUserProvidedFunctionApp.md index eb62a6843716..9950a5384b7b 100644 --- a/src/Websites/Websites/help/Register-AzStaticWebAppUserProvidedFunctionApp.md +++ b/src/Websites/Websites/help/Register-AzStaticWebAppUserProvidedFunctionApp.md @@ -12,27 +12,52 @@ Description for Register a user provided function app with a static site build ## SYNTAX -### RegisterViaJsonFilePath1 (Default) +### RegisterExpanded1 (Default) ``` Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name - -ResourceGroupName [-SubscriptionId ] [-Forced] -JsonFilePath + -ResourceGroupName [-SubscriptionId ] [-Forced] [-FunctionAppRegion ] + [-FunctionAppResourceId ] [-Kind ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### RegisterViaJsonString +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -EnvironmentName + -Name -ResourceGroupName [-SubscriptionId ] [-Forced] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` -### RegisterViaJsonString +### RegisterViaJsonFilePath ``` -Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name - -ResourceGroupName -EnvironmentName [-SubscriptionId ] [-Forced] - -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -EnvironmentName + -Name -ResourceGroupName [-SubscriptionId ] [-Forced] -JsonFilePath + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### RegisterViaIdentityStaticSiteExpanded +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -EnvironmentName + -StaticSiteInputObject [-Forced] [-FunctionAppRegion ] + [-FunctionAppResourceId ] [-Kind ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` -### RegisterViaJsonFilePath +### RegisterViaIdentityStaticSite ``` -Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name - -ResourceGroupName -EnvironmentName [-SubscriptionId ] [-Forced] - -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -EnvironmentName + -StaticSiteInputObject [-Forced] + -StaticSiteUserProvidedFunctionEnvelope + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### RegisterExpanded +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -EnvironmentName + -Name -ResourceGroupName [-SubscriptionId ] [-Forced] [-FunctionAppRegion ] + [-FunctionAppResourceId ] [-Kind ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` @@ -44,6 +69,47 @@ Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name < [] ``` +### RegisterViaJsonFilePath1 +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -Name + -ResourceGroupName [-SubscriptionId ] [-Forced] -JsonFilePath + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### RegisterViaIdentityBuildExpanded +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -BuildInputObject + [-Forced] [-FunctionAppRegion ] [-FunctionAppResourceId ] [-Kind ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### RegisterViaIdentityBuild +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName -BuildInputObject + [-Forced] -StaticSiteUserProvidedFunctionEnvelope + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### RegisterViaIdentityStaticSiteExpanded1 +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName + -StaticSiteInputObject [-Forced] [-FunctionAppRegion ] + [-FunctionAppResourceId ] [-Kind ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### RegisterViaIdentityStaticSite1 +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName + -StaticSite1InputObject [-Forced] + -StaticSiteUserProvidedFunctionEnvelope + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + ## DESCRIPTION Description for Register a user provided function app with a static site build @@ -94,6 +160,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -BuildInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RegisterViaIdentityBuildExpanded, RegisterViaIdentityBuild +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -115,7 +196,7 @@ The stage site identifier. ```yaml Type: System.String -Parameter Sets: RegisterViaJsonString, RegisterViaJsonFilePath +Parameter Sets: RegisterViaJsonString, RegisterViaJsonFilePath, RegisterViaIdentityStaticSiteExpanded, RegisterViaIdentityStaticSite, RegisterExpanded Aliases: Required: True @@ -156,12 +237,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FunctionAppRegion +The region of the function app registered with the static site + +```yaml +Type: System.String +Parameter Sets: RegisterExpanded1, RegisterViaIdentityStaticSiteExpanded, RegisterExpanded, RegisterViaIdentityBuildExpanded, RegisterViaIdentityStaticSiteExpanded1 +Aliases: + +Required: False +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 + +```yaml +Type: System.String +Parameter Sets: RegisterExpanded1, RegisterViaIdentityStaticSiteExpanded, RegisterExpanded, RegisterViaIdentityBuildExpanded, RegisterViaIdentityStaticSiteExpanded1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -JsonFilePath Path of Json file supplied to the Register operation ```yaml Type: System.String -Parameter Sets: RegisterViaJsonFilePath1, RegisterViaJsonFilePath +Parameter Sets: RegisterViaJsonFilePath, RegisterViaJsonFilePath1 Aliases: Required: True @@ -186,12 +297,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: RegisterExpanded1, RegisterViaIdentityStaticSiteExpanded, RegisterExpanded, RegisterViaIdentityBuildExpanded, RegisterViaIdentityStaticSiteExpanded1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Name of the static site. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: RegisterExpanded1, RegisterViaJsonString, RegisterViaJsonFilePath, RegisterExpanded, RegisterViaJsonString1, RegisterViaJsonFilePath1 Aliases: Required: True @@ -221,7 +347,7 @@ Name of the resource group to which the resource belongs. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: RegisterExpanded1, RegisterViaJsonString, RegisterViaJsonFilePath, RegisterExpanded, RegisterViaJsonString1, RegisterViaJsonFilePath1 Aliases: Required: True @@ -231,6 +357,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -StaticSite1InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RegisterViaIdentityStaticSite1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StaticSiteInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: RegisterViaIdentityStaticSiteExpanded, RegisterViaIdentityStaticSite, RegisterViaIdentityStaticSiteExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StaticSiteUserProvidedFunctionEnvelope +Static Site User Provided Function App ARM resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionAppArmResource +Parameter Sets: RegisterViaIdentityStaticSite, RegisterViaIdentityBuild, RegisterViaIdentityStaticSite1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SubscriptionId Your Azure subscription ID. This is a GUID-formatted string (e.g. @@ -238,7 +409,7 @@ This is a GUID-formatted string (e.g. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: RegisterExpanded1, RegisterViaJsonString, RegisterViaJsonFilePath, RegisterExpanded, RegisterViaJsonString1, RegisterViaJsonFilePath1 Aliases: Required: False @@ -284,6 +455,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionAppArmResource + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionAppArmResource diff --git a/src/Websites/Websites/help/Update-AzStaticWebAppUser.md b/src/Websites/Websites/help/Update-AzStaticWebAppUser.md index c0fd0a919d98..c1d018833097 100644 --- a/src/Websites/Websites/help/Update-AzStaticWebAppUser.md +++ b/src/Websites/Websites/help/Update-AzStaticWebAppUser.md @@ -40,6 +40,13 @@ Update-AzStaticWebAppUser -AuthProvider -UserId -StaticSiteInp [-Confirm] [] ``` +### UpdateViaIdentityStaticSite +``` +Update-AzStaticWebAppUser -AuthProvider -UserId -StaticSiteInputObject + -StaticSiteUserEnvelope [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + ### UpdateViaIdentityAuthproviderExpanded ``` Update-AzStaticWebAppUser -UserId -AuthproviderInputObject [-Kind ] @@ -47,6 +54,13 @@ Update-AzStaticWebAppUser -UserId -AuthproviderInputObject ] ``` +### UpdateViaIdentityAuthprovider +``` +Update-AzStaticWebAppUser -UserId -AuthproviderInputObject + -StaticSiteUserEnvelope [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + ### UpdateViaIdentityExpanded ``` Update-AzStaticWebAppUser -InputObject [-Kind ] [-Role ] @@ -92,7 +106,7 @@ The auth provider for this user. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityStaticSiteExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityStaticSiteExpanded, UpdateViaIdentityStaticSite Aliases: Required: True @@ -107,7 +121,7 @@ Identity Parameter ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: UpdateViaIdentityAuthproviderExpanded +Parameter Sets: UpdateViaIdentityAuthproviderExpanded, UpdateViaIdentityAuthprovider Aliases: Required: True @@ -243,7 +257,22 @@ Identity Parameter ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity -Parameter Sets: UpdateViaIdentityStaticSiteExpanded +Parameter Sets: UpdateViaIdentityStaticSiteExpanded, UpdateViaIdentityStaticSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StaticSiteUserEnvelope +Static Site User ARM resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserArmResource +Parameter Sets: UpdateViaIdentityStaticSite, UpdateViaIdentityAuthprovider Aliases: Required: True @@ -275,7 +304,7 @@ The user id of the user. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityStaticSiteExpanded, UpdateViaIdentityAuthproviderExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityStaticSiteExpanded, UpdateViaIdentityStaticSite, UpdateViaIdentityAuthproviderExpanded, UpdateViaIdentityAuthprovider Aliases: Required: True @@ -321,6 +350,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserArmResource + ### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity ## OUTPUTS From 0205cbd8784008bd2163f4da27054abadda7697a Mon Sep 17 00:00:00 2001 From: Qi Pan <43341456+Pan-Qi@users.noreply.github.com> Date: Mon, 4 Aug 2025 13:25:23 +1000 Subject: [PATCH 5/7] suppress breaking change --- .../Az.LoadTesting/BreakingChangeIssues.csv | 77 +++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 tools/StaticAnalysis/Exceptions/Az.LoadTesting/BreakingChangeIssues.csv diff --git a/tools/StaticAnalysis/Exceptions/Az.LoadTesting/BreakingChangeIssues.csv b/tools/StaticAnalysis/Exceptions/Az.LoadTesting/BreakingChangeIssues.csv new file mode 100644 index 000000000000..a2d893914f20 --- /dev/null +++ b/tools/StaticAnalysis/Exceptions/Az.LoadTesting/BreakingChangeIssues.csv @@ -0,0 +1,77 @@ +"Module","ClassName","Target","Severity","ProblemId","Description","Remediation" +"Az.Websites","Get-AzStaticWebApp","Get-AzStaticWebApp","0","3000","The type of property 'SkuCapability' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ICapability' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ICapability]'.","Change the type of property 'SkuCapability' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ICapability'." +"Az.Websites","Get-AzStaticWebApp","Get-AzStaticWebApp","0","3000","The type of property 'PrivateEndpointConnection' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IResponseMessageEnvelopeRemotePrivateEndpointConnection' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IResponseMessageEnvelopeRemotePrivateEndpointConnection]'.","Change the type of property 'PrivateEndpointConnection' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IResponseMessageEnvelopeRemotePrivateEndpointConnection'." +"Az.Websites","Get-AzStaticWebApp","Get-AzStaticWebApp","0","3000","The type of property 'UserProvidedFunctionApp' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionApp' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionApp]'.","Change the type of property 'UserProvidedFunctionApp' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionApp'." +"Az.Websites","Get-AzStaticWebApp","Get-AzStaticWebApp","0","3000","The type of property 'IdentityType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ManagedServiceIdentityType]' to 'System.String'.","Change the type of property 'IdentityType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ManagedServiceIdentityType]'." +"Az.Websites","Get-AzStaticWebApp","Get-AzStaticWebApp","0","3000","The type of property 'StagingEnvironmentPolicy' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy]' to 'System.String'.","Change the type of property 'StagingEnvironmentPolicy' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy]'." +"Az.Websites","Get-AzStaticWebApp","Get-AzStaticWebApp","0","3000","The type of property 'SkuLocation' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'System.String[]' to 'System.Collections.Generic.List`1[System.String]'.","Change the type of property 'SkuLocation' back to 'System.String[]'." +"Az.Websites","Get-AzStaticWebApp","Get-AzStaticWebApp","0","3000","The type of property 'CustomDomain' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'System.String[]' to 'System.Collections.Generic.List`1[System.String]'.","Change the type of property 'CustomDomain' back to 'System.String[]'." +"Az.Websites","Get-AzStaticWebAppBuild","Get-AzStaticWebAppBuild","0","3000","The type of property 'UserProvidedFunctionApp' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteBuildArmResource' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionApp' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionApp]'.","Change the type of property 'UserProvidedFunctionApp' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionApp'." +"Az.Websites","Get-AzStaticWebAppBuild","Get-AzStaticWebAppBuild","0","3000","The type of property 'Status' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteBuildArmResource' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.BuildStatus]' to 'System.String'.","Change the type of property 'Status' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.BuildStatus]'." +"Az.Websites","Get-AzStaticWebAppBuildFunction","Get-AzStaticWebAppBuildFunction","0","3000","The type of property 'TriggerType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteFunctionOverviewArmResource' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.TriggerTypes]' to 'System.String'.","Change the type of property 'TriggerType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.TriggerTypes]'." +"Az.Websites","Get-AzStaticWebAppConfiguredRole","Get-AzStaticWebAppConfiguredRole","0","3000","The type of property 'Property' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringList' has changed from 'System.String[]' to 'System.Collections.Generic.List`1[System.String]'.","Change the type of property 'Property' back to 'System.String[]'." +"Az.Websites","Get-AzStaticWebAppCustomDomain","Get-AzStaticWebAppCustomDomain","0","3000","The type of property 'Status' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteCustomDomainOverviewArmResource' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.CustomDomainStatus]' to 'System.String'.","Change the type of property 'Status' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.CustomDomainStatus]'." +"Az.Websites","Get-AzStaticWebAppFunction","Get-AzStaticWebAppFunction","0","3000","The type of property 'TriggerType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteFunctionOverviewArmResource' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.TriggerTypes]' to 'System.String'.","Change the type of property 'TriggerType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.TriggerTypes]'." +"Az.Websites","Get-AzWebAppContinuousWebJob","Get-AzWebAppContinuousWebJob","0","3000","The type of property 'Status' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IContinuousWebJob' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ContinuousWebJobStatus]' to 'System.String'.","Change the type of property 'Status' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ContinuousWebJobStatus]'." +"Az.Websites","Get-AzWebAppContinuousWebJob","Get-AzWebAppContinuousWebJob","0","3000","The type of property 'WebJobType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IContinuousWebJob' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.WebJobType]' to 'System.String'.","Change the type of property 'WebJobType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.WebJobType]'." +"Az.Websites","Get-AzWebAppContinuousWebJob","Get-AzWebAppContinuousWebJob","0","2000","The cmdlet 'Get-AzWebAppContinuousWebJob' no longer supports the parameter 'PassThru' and no alias was found for the original parameter name.","Add the parameter 'PassThru' back to the cmdlet 'Get-AzWebAppContinuousWebJob', or add an alias to the original parameter name." +"Az.Websites","Get-AzWebAppContinuousWebJob","Get-AzWebAppContinuousWebJob","0","1050","The parameter set 'Get' for cmdlet 'Get-AzWebAppContinuousWebJob' has been removed.","Add parameter set 'Get' back to cmdlet 'Get-AzWebAppContinuousWebJob'." +"Az.Websites","Get-AzWebAppContinuousWebJob","Get-AzWebAppContinuousWebJob","0","1050","The parameter set 'GetViaIdentity' for cmdlet 'Get-AzWebAppContinuousWebJob' has been removed.","Add parameter set 'GetViaIdentity' back to cmdlet 'Get-AzWebAppContinuousWebJob'." +"Az.Websites","Get-AzWebAppSlotContinuousWebJob","Get-AzWebAppSlotContinuousWebJob","0","3000","The type of property 'Status' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IContinuousWebJob' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ContinuousWebJobStatus]' to 'System.String'.","Change the type of property 'Status' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ContinuousWebJobStatus]'." +"Az.Websites","Get-AzWebAppSlotContinuousWebJob","Get-AzWebAppSlotContinuousWebJob","0","3000","The type of property 'WebJobType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IContinuousWebJob' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.WebJobType]' to 'System.String'.","Change the type of property 'WebJobType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.WebJobType]'." +"Az.Websites","Get-AzWebAppSlotContinuousWebJob","Get-AzWebAppSlotContinuousWebJob","0","2000","The cmdlet 'Get-AzWebAppSlotContinuousWebJob' no longer supports the parameter 'PassThru' and no alias was found for the original parameter name.","Add the parameter 'PassThru' back to the cmdlet 'Get-AzWebAppSlotContinuousWebJob', or add an alias to the original parameter name." +"Az.Websites","Get-AzWebAppSlotContinuousWebJob","Get-AzWebAppSlotContinuousWebJob","0","1050","The parameter set 'Get' for cmdlet 'Get-AzWebAppSlotContinuousWebJob' has been removed.","Add parameter set 'Get' back to cmdlet 'Get-AzWebAppSlotContinuousWebJob'." +"Az.Websites","Get-AzWebAppSlotContinuousWebJob","Get-AzWebAppSlotContinuousWebJob","0","1050","The parameter set 'GetViaIdentity' for cmdlet 'Get-AzWebAppSlotContinuousWebJob' has been removed.","Add parameter set 'GetViaIdentity' back to cmdlet 'Get-AzWebAppSlotContinuousWebJob'." +"Az.Websites","Get-AzWebAppSlotTriggeredWebJob","Get-AzWebAppSlotTriggeredWebJob","0","3000","The type of property 'LatestRunStatus' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredWebJob' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.TriggeredWebJobStatus]' to 'System.String'.","Change the type of property 'LatestRunStatus' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.TriggeredWebJobStatus]'." +"Az.Websites","Get-AzWebAppSlotTriggeredWebJob","Get-AzWebAppSlotTriggeredWebJob","0","3000","The type of property 'WebJobType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredWebJob' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.WebJobType]' to 'System.String'.","Change the type of property 'WebJobType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.WebJobType]'." +"Az.Websites","Get-AzWebAppSlotTriggeredWebJob","Get-AzWebAppSlotTriggeredWebJob","0","2000","The cmdlet 'Get-AzWebAppSlotTriggeredWebJob' no longer supports the parameter 'PassThru' and no alias was found for the original parameter name.","Add the parameter 'PassThru' back to the cmdlet 'Get-AzWebAppSlotTriggeredWebJob', or add an alias to the original parameter name." +"Az.Websites","Get-AzWebAppSlotTriggeredWebJob","Get-AzWebAppSlotTriggeredWebJob","0","1050","The parameter set 'Get' for cmdlet 'Get-AzWebAppSlotTriggeredWebJob' has been removed.","Add parameter set 'Get' back to cmdlet 'Get-AzWebAppSlotTriggeredWebJob'." +"Az.Websites","Get-AzWebAppSlotTriggeredWebJob","Get-AzWebAppSlotTriggeredWebJob","0","1050","The parameter set 'GetViaIdentity' for cmdlet 'Get-AzWebAppSlotTriggeredWebJob' has been removed.","Add parameter set 'GetViaIdentity' back to cmdlet 'Get-AzWebAppSlotTriggeredWebJob'." +"Az.Websites","Get-AzWebAppSlotTriggeredWebJobHistory","Get-AzWebAppSlotTriggeredWebJobHistory","0","3000","The type of property 'Run' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredJobHistory' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredJobRun' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredJobRun]'.","Change the type of property 'Run' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredJobRun'." +"Az.Websites","Get-AzWebAppSlotTriggeredWebJobHistory","Get-AzWebAppSlotTriggeredWebJobHistory","0","2000","The cmdlet 'Get-AzWebAppSlotTriggeredWebJobHistory' no longer supports the parameter 'PassThru' and no alias was found for the original parameter name.","Add the parameter 'PassThru' back to the cmdlet 'Get-AzWebAppSlotTriggeredWebJobHistory', or add an alias to the original parameter name." +"Az.Websites","Get-AzWebAppSlotTriggeredWebJobHistory","Get-AzWebAppSlotTriggeredWebJobHistory","0","1050","The parameter set 'List' for cmdlet 'Get-AzWebAppSlotTriggeredWebJobHistory' has been removed.","Add parameter set 'List' back to cmdlet 'Get-AzWebAppSlotTriggeredWebJobHistory'." +"Az.Websites","Get-AzWebAppSlotTriggeredWebJobHistory","Get-AzWebAppSlotTriggeredWebJobHistory","0","1050","The parameter set 'Get' for cmdlet 'Get-AzWebAppSlotTriggeredWebJobHistory' has been removed.","Add parameter set 'Get' back to cmdlet 'Get-AzWebAppSlotTriggeredWebJobHistory'." +"Az.Websites","Get-AzWebAppSlotTriggeredWebJobHistory","Get-AzWebAppSlotTriggeredWebJobHistory","0","1050","The parameter set 'GetViaIdentity' for cmdlet 'Get-AzWebAppSlotTriggeredWebJobHistory' has been removed.","Add parameter set 'GetViaIdentity' back to cmdlet 'Get-AzWebAppSlotTriggeredWebJobHistory'." +"Az.Websites","Get-AzWebAppSlotTriggeredWebJobHistory","Get-AzWebAppSlotTriggeredWebJobHistory","0","1050","The parameter set '__AllParameterSets' for cmdlet 'Get-AzWebAppSlotTriggeredWebJobHistory' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'Get-AzWebAppSlotTriggeredWebJobHistory'." +"Az.Websites","Get-AzWebAppSlotWebJob","Get-AzWebAppSlotWebJob","0","3000","The type of property 'WebJobType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IWebJob' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.WebJobType]' to 'System.String'.","Change the type of property 'WebJobType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.WebJobType]'." +"Az.Websites","Get-AzWebAppTriggeredWebJob","Get-AzWebAppTriggeredWebJob","0","3000","The type of property 'LatestRunStatus' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredWebJob' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.TriggeredWebJobStatus]' to 'System.String'.","Change the type of property 'LatestRunStatus' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.TriggeredWebJobStatus]'." +"Az.Websites","Get-AzWebAppTriggeredWebJob","Get-AzWebAppTriggeredWebJob","0","3000","The type of property 'WebJobType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredWebJob' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.WebJobType]' to 'System.String'.","Change the type of property 'WebJobType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.WebJobType]'." +"Az.Websites","Get-AzWebAppTriggeredWebJob","Get-AzWebAppTriggeredWebJob","0","2000","The cmdlet 'Get-AzWebAppTriggeredWebJob' no longer supports the parameter 'PassThru' and no alias was found for the original parameter name.","Add the parameter 'PassThru' back to the cmdlet 'Get-AzWebAppTriggeredWebJob', or add an alias to the original parameter name." +"Az.Websites","Get-AzWebAppTriggeredWebJob","Get-AzWebAppTriggeredWebJob","0","1050","The parameter set 'Get' for cmdlet 'Get-AzWebAppTriggeredWebJob' has been removed.","Add parameter set 'Get' back to cmdlet 'Get-AzWebAppTriggeredWebJob'." +"Az.Websites","Get-AzWebAppTriggeredWebJob","Get-AzWebAppTriggeredWebJob","0","1050","The parameter set 'GetViaIdentity' for cmdlet 'Get-AzWebAppTriggeredWebJob' has been removed.","Add parameter set 'GetViaIdentity' back to cmdlet 'Get-AzWebAppTriggeredWebJob'." +"Az.Websites","Get-AzWebAppTriggeredWebJobHistory","Get-AzWebAppTriggeredWebJobHistory","0","3000","The type of property 'Run' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredJobHistory' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredJobRun' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredJobRun]'.","Change the type of property 'Run' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ITriggeredJobRun'." +"Az.Websites","Get-AzWebAppTriggeredWebJobHistory","Get-AzWebAppTriggeredWebJobHistory","0","2000","The cmdlet 'Get-AzWebAppTriggeredWebJobHistory' no longer supports the parameter 'PassThru' and no alias was found for the original parameter name.","Add the parameter 'PassThru' back to the cmdlet 'Get-AzWebAppTriggeredWebJobHistory', or add an alias to the original parameter name." +"Az.Websites","Get-AzWebAppTriggeredWebJobHistory","Get-AzWebAppTriggeredWebJobHistory","0","1050","The parameter set 'List' for cmdlet 'Get-AzWebAppTriggeredWebJobHistory' has been removed.","Add parameter set 'List' back to cmdlet 'Get-AzWebAppTriggeredWebJobHistory'." +"Az.Websites","Get-AzWebAppTriggeredWebJobHistory","Get-AzWebAppTriggeredWebJobHistory","0","1050","The parameter set 'Get' for cmdlet 'Get-AzWebAppTriggeredWebJobHistory' has been removed.","Add parameter set 'Get' back to cmdlet 'Get-AzWebAppTriggeredWebJobHistory'." +"Az.Websites","Get-AzWebAppTriggeredWebJobHistory","Get-AzWebAppTriggeredWebJobHistory","0","1050","The parameter set 'GetViaIdentity' for cmdlet 'Get-AzWebAppTriggeredWebJobHistory' has been removed.","Add parameter set 'GetViaIdentity' back to cmdlet 'Get-AzWebAppTriggeredWebJobHistory'." +"Az.Websites","Get-AzWebAppTriggeredWebJobHistory","Get-AzWebAppTriggeredWebJobHistory","0","1050","The parameter set '__AllParameterSets' for cmdlet 'Get-AzWebAppTriggeredWebJobHistory' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'Get-AzWebAppTriggeredWebJobHistory'." +"Az.Websites","Get-AzWebAppWebJob","Get-AzWebAppWebJob","0","3000","The type of property 'WebJobType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IWebJob' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.WebJobType]' to 'System.String'.","Change the type of property 'WebJobType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.WebJobType]'." +"Az.Websites","New-AzStaticWebApp","New-AzStaticWebApp","0","3000","The type of property 'SkuCapability' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ICapability' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ICapability]'.","Change the type of property 'SkuCapability' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ICapability'." +"Az.Websites","New-AzStaticWebApp","New-AzStaticWebApp","0","3000","The type of property 'PrivateEndpointConnection' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IResponseMessageEnvelopeRemotePrivateEndpointConnection' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IResponseMessageEnvelopeRemotePrivateEndpointConnection]'.","Change the type of property 'PrivateEndpointConnection' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IResponseMessageEnvelopeRemotePrivateEndpointConnection'." +"Az.Websites","New-AzStaticWebApp","New-AzStaticWebApp","0","3000","The type of property 'UserProvidedFunctionApp' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionApp' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionApp]'.","Change the type of property 'UserProvidedFunctionApp' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionApp'." +"Az.Websites","New-AzStaticWebApp","New-AzStaticWebApp","0","3000","The type of property 'IdentityType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ManagedServiceIdentityType]' to 'System.String'.","Change the type of property 'IdentityType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ManagedServiceIdentityType]'." +"Az.Websites","New-AzStaticWebApp","New-AzStaticWebApp","0","3000","The type of property 'StagingEnvironmentPolicy' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy]' to 'System.String'.","Change the type of property 'StagingEnvironmentPolicy' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy]'." +"Az.Websites","New-AzStaticWebApp","New-AzStaticWebApp","0","3000","The type of property 'SkuLocation' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'System.String[]' to 'System.Collections.Generic.List`1[System.String]'.","Change the type of property 'SkuLocation' back to 'System.String[]'." +"Az.Websites","New-AzStaticWebApp","New-AzStaticWebApp","0","3000","The type of property 'CustomDomain' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'System.String[]' to 'System.Collections.Generic.List`1[System.String]'.","Change the type of property 'CustomDomain' back to 'System.String[]'." +"Az.Websites","New-AzStaticWebApp","New-AzStaticWebApp","0","2000","The cmdlet 'New-AzStaticWebApp' no longer supports the parameter 'IdentityType' and no alias was found for the original parameter name.","Add the parameter 'IdentityType' back to the cmdlet 'New-AzStaticWebApp', or add an alias to the original parameter name." +"Az.Websites","New-AzStaticWebApp","New-AzStaticWebApp","0","2000","The cmdlet 'New-AzStaticWebApp' no longer supports the parameter 'IdentityUserAssignedIdentity' and no alias was found for the original parameter name.","Add the parameter 'IdentityUserAssignedIdentity' back to the cmdlet 'New-AzStaticWebApp', or add an alias to the original parameter name." +"Az.Websites","New-AzStaticWebApp","New-AzStaticWebApp","0","2020","The cmdlet 'New-AzStaticWebApp' no longer supports the type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy' for parameter 'StagingEnvironmentPolicy'.","Change the type for parameter 'StagingEnvironmentPolicy' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy'." +"Az.Websites","New-AzStaticWebApp","New-AzStaticWebApp","0","1050","The parameter set '__AllParameterSets' for cmdlet 'New-AzStaticWebApp' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'New-AzStaticWebApp'." +"Az.Websites","New-AzStaticWebAppBuildAppSetting","New-AzStaticWebAppBuildAppSetting","0","1050","The parameter set '__AllParameterSets' for cmdlet 'New-AzStaticWebAppBuildAppSetting' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'New-AzStaticWebAppBuildAppSetting'." +"Az.Websites","New-AzStaticWebAppBuildFunctionAppSetting","New-AzStaticWebAppBuildFunctionAppSetting","0","1050","The parameter set '__AllParameterSets' for cmdlet 'New-AzStaticWebAppBuildFunctionAppSetting' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'New-AzStaticWebAppBuildFunctionAppSetting'." +"Az.Websites","New-AzStaticWebAppCustomDomain","New-AzStaticWebAppCustomDomain","0","3000","The type of property 'Status' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteCustomDomainOverviewArmResource' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.CustomDomainStatus]' to 'System.String'.","Change the type of property 'Status' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.CustomDomainStatus]'." +"Az.Websites","New-AzStaticWebAppFunctionAppSetting","New-AzStaticWebAppFunctionAppSetting","0","1050","The parameter set '__AllParameterSets' for cmdlet 'New-AzStaticWebAppFunctionAppSetting' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'New-AzStaticWebAppFunctionAppSetting'." +"Az.Websites","New-AzStaticWebAppSetting","New-AzStaticWebAppSetting","0","1050","The parameter set '__AllParameterSets' for cmdlet 'New-AzStaticWebAppSetting' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'New-AzStaticWebAppSetting'." +"Az.Websites","New-AzStaticWebAppUserRoleInvitationLink","New-AzStaticWebAppUserRoleInvitationLink","0","1050","The parameter set '__AllParameterSets' for cmdlet 'New-AzStaticWebAppUserRoleInvitationLink' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'New-AzStaticWebAppUserRoleInvitationLink'." +"Az.Websites","Reset-AzStaticWebAppApiKey","Reset-AzStaticWebAppApiKey","0","1050","The parameter set '__AllParameterSets' for cmdlet 'Reset-AzStaticWebAppApiKey' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'Reset-AzStaticWebAppApiKey'." +"Az.Websites","Test-AzStaticWebAppCustomDomain","Test-AzStaticWebAppCustomDomain","0","1050","The parameter set '__AllParameterSets' for cmdlet 'Test-AzStaticWebAppCustomDomain' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'Test-AzStaticWebAppCustomDomain'." +"Az.Websites","Update-AzStaticWebApp","Update-AzStaticWebApp","0","3000","The type of property 'SkuCapability' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ICapability' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ICapability]'.","Change the type of property 'SkuCapability' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.ICapability'." +"Az.Websites","Update-AzStaticWebApp","Update-AzStaticWebApp","0","3000","The type of property 'PrivateEndpointConnection' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IResponseMessageEnvelopeRemotePrivateEndpointConnection' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IResponseMessageEnvelopeRemotePrivateEndpointConnection]'.","Change the type of property 'PrivateEndpointConnection' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IResponseMessageEnvelopeRemotePrivateEndpointConnection'." +"Az.Websites","Update-AzStaticWebApp","Update-AzStaticWebApp","0","3000","The type of property 'UserProvidedFunctionApp' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionApp' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionApp]'.","Change the type of property 'UserProvidedFunctionApp' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionApp'." +"Az.Websites","Update-AzStaticWebApp","Update-AzStaticWebApp","0","3000","The type of property 'IdentityType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ManagedServiceIdentityType]' to 'System.String'.","Change the type of property 'IdentityType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ManagedServiceIdentityType]'." +"Az.Websites","Update-AzStaticWebApp","Update-AzStaticWebApp","0","3000","The type of property 'StagingEnvironmentPolicy' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy]' to 'System.String'.","Change the type of property 'StagingEnvironmentPolicy' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy]'." +"Az.Websites","Update-AzStaticWebApp","Update-AzStaticWebApp","0","3000","The type of property 'SkuLocation' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'System.String[]' to 'System.Collections.Generic.List`1[System.String]'.","Change the type of property 'SkuLocation' back to 'System.String[]'." +"Az.Websites","Update-AzStaticWebApp","Update-AzStaticWebApp","0","3000","The type of property 'CustomDomain' of type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource' has changed from 'System.String[]' to 'System.Collections.Generic.List`1[System.String]'.","Change the type of property 'CustomDomain' back to 'System.String[]'." +"Az.Websites","Update-AzStaticWebApp","Update-AzStaticWebApp","0","2020","The cmdlet 'Update-AzStaticWebApp' no longer supports the type 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy' for parameter 'StagingEnvironmentPolicy'.","Change the type for parameter 'StagingEnvironmentPolicy' back to 'Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy'." +"Az.Websites","Update-AzStaticWebApp","Update-AzStaticWebApp","0","1050","The parameter set '__AllParameterSets' for cmdlet 'Update-AzStaticWebApp' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'Update-AzStaticWebApp'." +"Az.Websites","Update-AzStaticWebAppUser","Update-AzStaticWebAppUser","0","1050","The parameter set '__AllParameterSets' for cmdlet 'Update-AzStaticWebAppUser' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'Update-AzStaticWebAppUser'." From 925fde53bd38f483008f0079c5f4aaaa825b5476 Mon Sep 17 00:00:00 2001 From: Qi Pan <43341456+Pan-Qi@users.noreply.github.com> Date: Fri, 31 Oct 2025 17:33:43 +1100 Subject: [PATCH 6/7] update unified changelog --- src/Websites/Websites/ChangeLog.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/src/Websites/Websites/ChangeLog.md b/src/Websites/Websites/ChangeLog.md index f37a025ed5f2..abbf1288765a 100644 --- a/src/Websites/Websites/ChangeLog.md +++ b/src/Websites/Websites/ChangeLog.md @@ -18,11 +18,7 @@ - Additional information about change #1 --> ## Upcoming Release -* Introduced various new features by upgrading code generator. Please see details [here](https://github.com/Azure/azure-powershell/blob/main/documentation/Autorest-powershell-v4-new-features.md). -* The parameters of the `New-AzStaticWebApp` cmdlet will be changed by new Managed Identity settings. - - Removed `-IdentityType` and `-IdentityUserAssignedIdentity` parameters. - - Added `-UserAssignedIdentity` parameter. The type of `UserAssignedIdentity` is simplified to a list of strings that is used to specify the user's assigned identity. - - Added `EnableSystemAssignedIdentity` to enable/disable system-assigned identities. +Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249). ## Version 3.4.1 * Added AppServicePlan management support for Pv4 and Pmv4 tiers. From b69cbde15a9c511eded24dc75fd2a072b65ed102 Mon Sep 17 00:00:00 2001 From: Qi Pan <43341456+Pan-Qi@users.noreply.github.com> Date: Fri, 31 Oct 2025 17:46:12 +1100 Subject: [PATCH 7/7] update unified changelog --- src/Websites/Websites/ChangeLog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Websites/Websites/ChangeLog.md b/src/Websites/Websites/ChangeLog.md index abbf1288765a..0cb7df8dabf0 100644 --- a/src/Websites/Websites/ChangeLog.md +++ b/src/Websites/Websites/ChangeLog.md @@ -18,7 +18,7 @@ - Additional information about change #1 --> ## Upcoming Release -Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249). +* Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249). ## Version 3.4.1 * Added AppServicePlan management support for Pv4 and Pmv4 tiers.