Azure / Azure/azure-powershell

Az.Functions cmdlet help content should not include complex parameter properties

Open
#15,044 4 comments 0 reactions 2 assignees Claimed by @dingmeng-xue View on GitHub
act-observability-squad Doc - Reference feature-request Functions
Dominant language
C#
Stars
4.8k
Forks
4.3k
Avg merge
2d 17h
Merged PRs (30d)
51

Description

## Description

If you run `Get-Help Update-AzFunctionApp -Full` the output between the Parameters and Examples section includes the following which should not be there:

This needs to be removed.

```
INPUTS
Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite

OUTPUTS
Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite

NOTES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT :
Location : Resource Location.
CloningInfoSourceWebAppId : ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for
production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.
[Kind ]: Kind of resource.
[Tag ]: Resource tags.
[(Any) ]: This indicates any property can be added to this object.
[ClientAffinityEnabled ]: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance.
Default is true.
[ClientCertEnabled ]: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.
[ClientCertExclusionPath ]: client certificate authentication comma-separated exclusion paths
[CloningInfoAppSettingsOverride ]: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise,
application settings from source app are retained.
[(Any) ]: This indicates any property can be added to this object.
[CloningInfoCloneCustomHostName ]: true to clone custom hostnames from source app; otherwise, false.
[CloningInfoCloneSourceControl ]: true to clone source control from source app; otherwise, false.
[CloningInfoConfigureLoadBalancing ]: true to configure load balancing for source and destination app.
[CloningInfoCorrelationId ]: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.
[CloningInfoHostingEnvironment ]: App Service Environment.
[CloningInfoOverwrite ]: true to overwrite destination app; otherwise, false.
[CloningInfoSourceWebAppLocation ]: Location of source app ex: West US or North Europe
[CloningInfoTrafficManagerProfileId ]: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.
[CloningInfoTrafficManagerProfileName ]: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.
[Config ]: Configuration of the app.
IsPushEnabled : Gets or sets a flag indicating whether the Push endpoint is enabled.
[ActionMinProcessExecutionTime ]: Minimum time the process must execute before taking the action
[ActionType ]: Predefined action to be taken.
[AlwaysOn ]: true if Always On is enabled; otherwise, false.
[ApiDefinitionUrl ]: The URL of the API definition.
[ApiManagementConfigId ]: APIM-Api Identifier.
[AppCommandLine ]: App command line to launch.
[AppSetting ]: Application settings.
[Name ]: Pair name.
[Value ]: Pair value.
[AutoHealEnabled ]: true if Auto Heal is enabled; otherwise, false.
[AutoSwapSlotName ]: Auto-swap slot name.
[ConnectionString ]: Connection strings.
[ConnectionString ]: Connection string value.
[Name ]: Name of connection string.
[Type ]: Type of database.
[CorAllowedOrigin ]: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all.
[CorSupportCredentials ]: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more
details.
[CustomActionExe ]: Executable to be run.
[CustomActionParameter ]: Parameters for the executable.
[DefaultDocument ]: Default documents.
[DetailedErrorLoggingEnabled ]: true if detailed error logging is enabled; otherwise, false.
[DocumentRoot ]: Document root.
[DynamicTagsJson ]: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.
[ExperimentRampUpRule ]: List of ramp-up rules.
[ActionHostName ]: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.
[ChangeDecisionCallbackUrl ]: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.
https://www.siteextensions.net/packages/TiPCallback/
[ChangeIntervalInMinute ]: Specifies interval in minutes to reevaluate ReroutePercentage.
[ChangeStep ]: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or
MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which
URL can be specified in ChangeDecisionCallbackUrl.
[MaxReroutePercentage ]: Specifies upper boundary below which ReroutePercentage will stay.
[MinReroutePercentage ]: Specifies lower boundary above which ReroutePercentage will stay.
[Name ]: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.
[ReroutePercentage ]: Percentage of the traffic which will be redirected to ActionHostName.
[FtpsState ]: State of FTP / FTPS service
[HandlerMapping ]: Handler mappings.
[Argument ]: Command-line arguments to be passed to the script processor.
[Extension ]: Requests with this extension will be handled using the specified FastCGI application.
[ScriptProcessor ]: The absolute path to the FastCGI application.
[HealthCheckPath ]: Health check path
[Http20Enabled ]: Http20Enabled: configures a web site to allow clients to connect over http2.0
[HttpLoggingEnabled ]: true if HTTP logging is enabled; otherwise, false.
[IPSecurityRestriction ]: IP security restrictions for main.
[Action ]: Allow or Deny access for this IP range.
[Description ]: IP restriction rule description.
[IPAddress ]: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit
match). For CIDR, SubnetMask property must not be specified.
[Name ]: IP restriction rule name.
[Priority ]: Priority of IP restriction rule.
[SubnetMask ]: Subnet mask for the range of IP addresses the restriction is valid for.
[SubnetTrafficTag ]: (internal) Subnet traffic tag
[Tag ]: Defines what this IP filter will be used for. This is to support IP filtering on proxies.
[VnetSubnetResourceId ]: Virtual network resource id
[VnetTrafficTag ]: (internal) Vnet traffic tag
[JavaContainer ]: Java container.
[JavaContainerVersion ]: Java container version.
[JavaVersion ]: Java version.
[LimitMaxDiskSizeInMb ]: Maximum allowed disk size usage in MB.
[LimitMaxMemoryInMb ]: Maximum allowed memory usage in MB.
[LimitMaxPercentageCpu ]: Maximum allowed CPU usage percentage.
[LinuxFxVersion ]: Linux App Framework and version
[LoadBalancing ]: Site load balancing.
[LocalMySqlEnabled ]: true to enable local MySQL; otherwise, false.
[LogsDirectorySizeLimit ]: HTTP logs directory size limit.
[MachineKeyDecryption ]: Algorithm used for decryption.
[MachineKeyDecryptionKey ]: Decryption key.
[MachineKeyValidation ]: MachineKey validation.
[MachineKeyValidationKey ]: Validation key.
[ManagedPipelineMode ]: Managed pipeline mode.
[ManagedServiceIdentityId ]: Managed Service Identity Id
[MinTlsVersion ]: MinTlsVersion: configures the minimum version of TLS required for SSL requests
[NetFrameworkVersion ]: .NET Framework version.
[NodeVersion ]: Version of Node.js.
[NumberOfWorker ]: Number of workers.
[PhpVersion ]: Version of PHP.
[PowerShellVersion ]: Version of PowerShell.
[PreWarmedInstanceCount ]: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans
[PublishingUsername ]: Publishing user name.
[PushKind ]: Kind of resource.
[PythonVersion ]: Version of Python.
[RemoteDebuggingEnabled ]: true if remote debugging is enabled; otherwise, false.
[RemoteDebuggingVersion ]: Remote debugging version.
[RequestCount ]: Request Count.
[RequestTimeInterval ]: Time interval.
[RequestTracingEnabled ]: true if request tracing is enabled; otherwise, false.
[RequestTracingExpirationTime ]: Request tracing expiration time.
[ScmIPSecurityRestriction ]: IP security restrictions for scm.
[ScmIPSecurityRestrictionsUseMain ]: IP security restrictions for scm to use main.
[ScmType ]: SCM type.
[SlowRequestCount ]: Request Count.
[SlowRequestTimeInterval ]: Time interval.
[SlowRequestTimeTaken ]: Time taken.
[TagWhitelistJson ]: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.
[TagsRequiringAuth ]: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric
characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler.
[TracingOption ]: Tracing options.
[TriggerPrivateBytesInKb ]: A rule based on private bytes.
[TriggerStatusCode ]: A rule based on status codes.
[Count ]: Request Count.
[Status ]: HTTP status code.
[SubStatus ]: Request Sub Status.
[TimeInterval ]: Time interval.
[Win32Status ]: Win32 error code.
[Use32BitWorkerProcess ]: true to use 32-bit worker process; otherwise, false.
[VirtualApplication ]: Virtual applications.
[PhysicalPath ]: Physical path.
[PreloadEnabled ]: true if preloading is enabled; otherwise, false.
[VirtualDirectory ]: Virtual directories for virtual application.
[PhysicalPath ]: Physical path.
[VirtualPath ]: Path to virtual application.
[VirtualPath ]: Virtual path.
[VnetName ]: Virtual Network name.
[WebSocketsEnabled ]: true if WebSocket is enabled; otherwise, false.
[WindowsFxVersion ]: Xenon App Framework and version
[XManagedServiceIdentityId ]: Explicit Managed Service Identity Id
[ContainerSize ]: Size of the function container.
[DailyMemoryTimeQuota ]: Maximum allowed daily memory-time quota (applicable on dynamic apps only).
[Enabled ]: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).
[HostNameSslState ]: Hostname SSL states are used to manage the SSL bindings for app's hostnames.
[HostType ]: Indicates whether the hostname is a standard or repository hostname.
[Name ]: Hostname.
[SslState ]: SSL type.
[Thumbprint ]: SSL certificate thumbprint.
[ToUpdate ]: Set to true to update existing hostname.
[VirtualIP ]: Virtual IP address assigned to the hostname if IP based SSL is enabled.
[HostNamesDisabled ]: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.
[HostingEnvironmentProfileId ]: Resource ID of the App Service Environment.
[HttpsOnly ]: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests
[HyperV ]: Hyper-V sandbox.
[IdentityType ]: Type of managed service identity.
[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}
[(Any) ]: This indicates any property can be added to this object.
[IsXenon ]: Obsolete: Hyper-V sandbox.
[RedundancyMode ]: Site redundancy mode
[Reserved ]: true if reserved; otherwise, false.
[ScmSiteAlsoStopped ]: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.
[ServerFarmId ]: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

-------------------------- EXAMPLE 1 --------------------------

PS C:\>Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -PlanName NewPlanName
```

## Steps to reproduce

```powershell
Get-Help Update-AzFunctionApp -Full
```

## Environment data

```

Name Value
---- -----
PSVersion 7.0.6
PSEdition Core
GitCommitId 7.0.6
OS Microsoft Windows 6.2.9200
Platform Win32NT
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0

```

## Module versions

```powershell
PS C:\> Get-Module -ListAvailable Az.Functions

Directory: C:\Program Files\PowerShell\Modules

ModuleType Version PreRelease Name PSEdition ExportedCommands
---------- ------- ---------- ---- --------- ----------------
Script 2.0.0 Az.Functions Core,Desk {Get-AzFunctionApp, Get-AzFunctionAppAvailableLocation, Get-AzFunctionAppPlan, Get-AzFunctionAppSetting…}

PS C:\>

```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.