diff --git a/command-signatures/json/autogenerated/powershell/add-appprovisionedsharedpackagecontainer.json b/command-signatures/json/autogenerated/powershell/add-appprovisionedsharedpackagecontainer.json new file mode 100644 index 00000000..4df4077e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-appprovisionedsharedpackagecontainer.json @@ -0,0 +1,264 @@ +{ + "name": "Add-AppProvisionedSharedPackageContainer", + "options": [ + { + "name": "-DefinitionFile", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + }, + { + "name": "Debug" + } + ] + } + ] + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Online", + "isRequired": true + }, + { + "name": "-Path", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Add-AppProvisionedSharedPackageContainer -DefinitionFile -Path [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] Add-AppProvisionedSharedPackageContainer -DefinitionFile -Online [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-appsharedpackagecontainer.json b/command-signatures/json/autogenerated/powershell/add-appsharedpackagecontainer.json new file mode 100644 index 00000000..c1a0a24a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-appsharedpackagecontainer.json @@ -0,0 +1,210 @@ +{ + "name": "Add-AppSharedPackageContainer", + "options": [ + { + "name": "-Force" + }, + { + "name": "-ForceApplicationShutdown" + }, + { + "name": "-Merge" + }, + { + "name": [ + "-Path", + "-PSPath" + ], + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-RequirePackagesPresent" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path" + } + ], + "description": "Add-AppSharedPackageContainer [-Path] [-ForceApplicationShutdown] [-Merge] [-RequirePackagesPresent] [-Force] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-appxpackage.json b/command-signatures/json/autogenerated/powershell/add-appxpackage.json new file mode 100644 index 00000000..680ba23e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-appxpackage.json @@ -0,0 +1,347 @@ +{ + "name": "Add-AppxPackage", + "options": [ + { + "name": "-AllowUnsigned" + }, + { + "name": "-AppInstallerFile", + "isRequired": true + }, + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-DeferRegistrationWhenPackagesAreInUse" + }, + { + "name": "-DependencyPackages", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-DependencyPath", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-DisableDevelopmentMode" + }, + { + "name": "-ExternalLocation", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-ExternalPackages", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-ForceApplicationShutdown" + }, + { + "name": "-ForceTargetApplicationShutdown" + }, + { + "name": "-ForceUpdateFromAnyVersion" + }, + { + "name": "-InstallAllResources" + }, + { + "name": "-LimitToExistingPackages" + }, + { + "name": "-MainPackage", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-OptionalPackages", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-Path", + "-PSPath" + ], + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-Register", + "isRequired": true + }, + { + "name": "-RegisterByFamilyName", + "isRequired": true + }, + { + "name": "-RelatedPackages", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-RequiredContentGroupOnly" + }, + { + "name": "-RetainFilesOnFailure" + }, + { + "name": "-Stage", + "isRequired": true + }, + { + "name": "-StubPackageOption", + "args": [ + { + "name": "StubPackageOption", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "InstallFull" + }, + { + "name": "InstallStub" + }, + { + "name": "UsePreference" + } + ] + } + ] + }, + { + "name": "-Update", + "isRequired": true + }, + { + "name": "-Volume", + "args": [ + { + "name": "AppxVolume" + } + ] + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path" + } + ], + "description": "Add-AppxPackage [-Path] [-DependencyPath ] [-RequiredContentGroupOnly] [-ForceApplicationShutdown] [-ForceTargetApplicationShutdown] [-ForceUpdateFromAnyVersion] [-RetainFilesOnFailure] [-InstallAllResources] [-Volume ] [-ExternalPackages ] [-OptionalPackages ] [-RelatedPackages ] [-ExternalLocation ] [-DeferRegistrationWhenPackagesAreInUse] [-StubPackageOption ] [-AllowUnsigned] [-WhatIf] [-Confirm] [] Add-AppxPackage [-Path] -AppInstallerFile [-RequiredContentGroupOnly] [-ForceTargetApplicationShutdown] [-InstallAllResources] [-LimitToExistingPackages] [-Volume ] [-WhatIf] [-Confirm] [] Add-AppxPackage [-Path] -Register [-DependencyPath ] [-DisableDevelopmentMode] [-ForceApplicationShutdown] [-ForceTargetApplicationShutdown] [-ForceUpdateFromAnyVersion] [-InstallAllResources] [-ExternalLocation ] [-WhatIf] [-Confirm] [] Add-AppxPackage [-Path] -Update [-DependencyPath ] [-RequiredContentGroupOnly] [-ForceApplicationShutdown] [-ForceTargetApplicationShutdown] [-ForceUpdateFromAnyVersion] [-RetainFilesOnFailure] [-InstallAllResources] [-WhatIf] [-Confirm] [] Add-AppxPackage [-Path] -Stage [-DependencyPath ] [-RequiredContentGroupOnly] [-ForceUpdateFromAnyVersion] [-Volume ] [-ExternalPackages ] [-OptionalPackages ] [-RelatedPackages ] [-ExternalLocation ] [-StubPackageOption ] [-AllowUnsigned] [-WhatIf] [-Confirm] [] Add-AppxPackage -MainPackage [-Register] [-DependencyPackages ] [-ForceApplicationShutdown] [-ForceTargetApplicationShutdown] [-ForceUpdateFromAnyVersion] [-InstallAllResources] [-WhatIf] [-Confirm] [] Add-AppxPackage -RegisterByFamilyName -MainPackage [-DependencyPackages ] [-ForceApplicationShutdown] [-ForceTargetApplicationShutdown] [-InstallAllResources] [-OptionalPackages ] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-appxprovisionedpackage.json b/command-signatures/json/autogenerated/powershell/add-appxprovisionedpackage.json new file mode 100644 index 00000000..71f718eb --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-appxprovisionedpackage.json @@ -0,0 +1,349 @@ +{ + "name": "Add-AppxProvisionedPackage", + "options": [ + { + "name": "-CustomDataPath", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location of a custom data file. The custom data file will be renamed custom.data and saved in the app data store." + }, + { + "name": "-DependencyPackagePath", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies the location of a dependency package." + }, + { + "name": "-FolderPath", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a folder of unpacked app package files containing a main package and any dependency packages. This folder must also contain your application license." + }, + { + "name": "-LicensePath", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies the location of the .xml file containing your application license." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs." + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-OptionalPackagePath", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies the path to an optional package that will also be provisioned. For more information on optional packages, see [Optional packages and related set authoring](/windows/msix/package/optional-packages)." + }, + { + "name": "-PackagePath", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location of the app package (.appx) to add to the Windows image. This package will be added for every new user account. To add an app package (.appx) for a particular user or to test a package while developing your app, use the Add-AppxPackage cmdlet instead." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-Regions", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies what regions an app package (.appx or .appxbundle) must be provisioned in. The region argument can either be \"all\", indicating that the app should be provisioned for all regions, or it can be a semi-colon delimited list of regions. The regions will be in the form of [ISO 3166-1 Alpha-2 or ISO 3166-1 Alpha-3 codes](https://en.wikipedia.org/wiki/ISO_3166-1). For example, the United States can be specified as either \"US\" or \"USA\" (case-insensitive). When a list of regions is not specified, the package will be provisioned only if it is pinned to start layout." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SkipLicense", + "description": "Adds an app package without a license file." + }, + { + "name": "-StubPackageOption", + "args": [ + { + "name": "StubPackageOption", + "suggestions": [ + { + "name": "InstallFull" + }, + { + "name": "InstallStub" + }, + { + "name": "None" + } + ] + } + ], + "description": "Specifies the stub preference of the package. If no stub package option is specified then the provisioned package version is set to the predefined stub preferences." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Adds an app package (.appx) that will install for each new user to a Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-appxvolume.json b/command-signatures/json/autogenerated/powershell/add-appxvolume.json new file mode 100644 index 00000000..dcff541b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-appxvolume.json @@ -0,0 +1,210 @@ +{ + "name": "Add-AppxVolume", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": [ + "-Path", + "-PSPath" + ], + "args": [ + { + "name": "string[]" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path" + } + ], + "description": "Add-AppxVolume [-Path] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-bitsfile.json b/command-signatures/json/autogenerated/powershell/add-bitsfile.json new file mode 100644 index 00000000..fa5ddb66 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-bitsfile.json @@ -0,0 +1,238 @@ +{ + "name": "Add-BitsFile", + "options": [ + { + "name": "-BitsJob", + "args": [ + { + "name": "BitsJob[]" + } + ], + "isRequired": true, + "description": "Specifies the BITS transfer jobs to which you want to add files. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as Get-BitsTransfer." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Destination", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies the destination location and the names of the files that you want to transfer. The destination names are paired with the corresponding source file names. For instance, the first file name specified in the *Source* parameter corresponds to the first file name in the *Destination* parameter, and the second file name in the *Source* parameter corresponds to the second file name in the *Destination* parameter. The *Source* and *Destination* parameters must have the same number of elements; otherwise, the command produces an error." + }, + { + "name": "-Source", + "args": [ + { + "name": "String[]" + } + ], + "isRequired": true, + "description": "Specifies the source location and the names of the files that you want to transfer. The source file names are paired with the corresponding destination file names. For instance, the first file name specified in the *Source* parameter corresponds to the first file name in the *Destination* parameter, and the second file name in the *Source* parameter corresponds to the second file name in the *Destination* parameter. The *Source* and *Destination* parameters must have the same number of elements; otherwise, the command produces an error. You can use standard wildcard characters such as the asterisk (*) and the question mark (?), or you can use a range operator such as \"\\[a-r\\]\"." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-BitsJob", + "description": "Specifies the BITS transfer jobs to which you want to add files. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as Get-BitsTransfer." + }, + { + "name": "-Source", + "description": "Specifies the source location and the names of the files that you want to transfer. The source file names are paired with the corresponding destination file names. For instance, the first file name specified in the *Source* parameter corresponds to the first file name in the *Destination* parameter, and the second file name in the *Source* parameter corresponds to the second file name in the *Destination* parameter. The *Source* and *Destination* parameters must have the same number of elements; otherwise, the command produces an error. You can use standard wildcard characters such as the asterisk (*) and the question mark (?), or you can use a range operator such as \"\\[a-r\\]\"." + }, + { + "name": "-Destination", + "description": "Specifies the destination location and the names of the files that you want to transfer. The destination names are paired with the corresponding source file names. For instance, the first file name specified in the *Source* parameter corresponds to the first file name in the *Destination* parameter, and the second file name in the *Source* parameter corresponds to the second file name in the *Destination* parameter. The *Source* and *Destination* parameters must have the same number of elements; otherwise, the command produces an error." + } + ], + "description": "Adds one or more files to an existing BITS transfer job.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-certificateenrollmentpolicyserver.json b/command-signatures/json/autogenerated/powershell/add-certificateenrollmentpolicyserver.json new file mode 100644 index 00000000..bee44c73 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-certificateenrollmentpolicyserver.json @@ -0,0 +1,245 @@ +{ + "name": "Add-CertificateEnrollmentPolicyServer", + "options": [ + { + "name": "-AutoEnrollmentEnabled", + "description": "Enables auto-enrollment for the policy server being added." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Credential", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.PkiCredential" + } + ], + "description": "Specifies the credential used to authenticate to the policy server. This credential can be a PSCredential object, which is a username and password, an x509 certificate, or a path to an x509 certificate. Kerberos authentication is used if no credential is specified." + }, + { + "name": "-NoClobber", + "description": "Prevents an enrollment policy server from overwriting an existing one." + }, + { + "name": "-RequireStrongValidation", + "description": "Specifies that the certificate obtained through this enrollment policy server must be trusted on the client." + }, + { + "name": "-Url", + "args": [ + { + "name": "System.Uri" + } + ], + "isRequired": true, + "description": "Identifies the uniform resource locator (URL) of the enrollment policy server to configure." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": "-Context", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.Context", + "suggestions": [ + { + "name": "Machine" + }, + { + "name": "User" + } + ] + } + ], + "isRequired": true, + "description": "Stores information about the policy server in the configuration for the Current User or Local computer." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Adds an enrollment policy server to the current user or local system configuration.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-computer.json b/command-signatures/json/autogenerated/powershell/add-computer.json new file mode 100644 index 00000000..1f4c6cf6 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-computer.json @@ -0,0 +1,335 @@ +{ + "name": "Add-Computer", + "options": [ + { + "name": "-ComputerName", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": [ + "-Credential", + "-DomainCredential" + ], + "args": [ + { + "name": "pscredential" + } + ], + "isRequired": true + }, + { + "name": [ + "-DomainName", + "-DN", + "-Domain" + ], + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-Force" + }, + { + "name": "-LocalCredential", + "args": [ + { + "name": "pscredential" + } + ] + }, + { + "name": "-NewName", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-OUPath", + "-OU" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Options", + "args": [ + { + "name": "JoinOptions", + "suggestions": [ + { + "name": "AccountCreate" + }, + { + "name": "Win9XUpgrade" + }, + { + "name": "UnsecuredJoin" + }, + { + "name": "PasswordPass" + }, + { + "name": "DeferSPNSet" + }, + { + "name": "JoinWithNewName" + }, + { + "name": "JoinReadOnly" + }, + { + "name": "InstallInvoke" + } + ] + } + ] + }, + { + "name": "-PassThru" + }, + { + "name": "-Restart" + }, + { + "name": [ + "-Server", + "-DC" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-UnjoinDomainCredential", + "args": [ + { + "name": "pscredential" + } + ] + }, + { + "name": "-Unsecure" + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-WorkgroupName", + "-WGN" + ], + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-DomainName-Or-WorkgroupName" + } + ], + "description": "Add-Computer [-DomainName] -Credential [-ComputerName ] [-LocalCredential ] [-UnjoinDomainCredential ] [-OUPath ] [-Server ] [-Unsecure] [-Options ] [-Restart] [-PassThru] [-NewName ] [-Force] [-WhatIf] [-Confirm] [] Add-Computer [-WorkgroupName] [-ComputerName ] [-LocalCredential ] [-Credential ] [-Restart] [-PassThru] [-NewName ] [-Force] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-content.json b/command-signatures/json/autogenerated/powershell/add-content.json index bd35b4cb..721052d4 100644 --- a/command-signatures/json/autogenerated/powershell/add-content.json +++ b/command-signatures/json/autogenerated/powershell/add-content.json @@ -3,7 +3,14 @@ "options": [ { "name": "-AsByteStream", - "description": "Specifies that the content should be read as a stream of bytes. This parameter was introduced in PowerShell 6.0.\n" + "description": "Specifies that the content should be read as a stream of bytes. This parameter was introduced in PowerShell 6.0." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-Credential", @@ -11,7 +18,8 @@ { "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter isn't supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Encoding", @@ -20,40 +28,42 @@ "name": "System.Text.Encoding", "suggestions": [ { - "name": "ASCII" + "name": "ansi" + }, + { + "name": "ascii" }, { - "name": "BigEndianUnicode" + "name": "bigendianunicode" }, { - "name": "BigEndianUTF32" + "name": "bigendianutf32" }, { - "name": "OEM" + "name": "oem" }, { - "name": "Unicode" + "name": "unicode" }, { - "name": "UTF7" + "name": "utf32" }, { - "name": "UTF8" + "name": "utf7" }, { - "name": "UTF8BOM" + "name": "utf8" }, { - "name": "UTF8NoBOM" + "name": "utf8BOM" }, { - "name": "UTF32" + "name": "utf8NoBOM" } - ], - "default": "UTF8NoBOM" + ] } ], - "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`.\n" + "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`." }, { "name": "-Exclude", @@ -62,7 +72,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -71,7 +81,7 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved." }, { "name": "-Force", @@ -84,7 +94,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -98,11 +108,11 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-NoNewline", - "description": "Indicates that this cmdlet doesn't add a new line or carriage return to the content.\n" + "description": "Indicates that this cmdlet doesn't add a new line or carriage return to the content." }, { "name": "-PassThru", @@ -125,7 +135,7 @@ "name": "System.String" } ], - "description": "Specifies an alternative data stream for content. If the stream doesn't exist, this cmdlet creates it. Wildcard characters aren't supported. Stream is a dynamic parameter that the FileSystem provider adds to `Add-Content`. This parameter works only in file system drives.\n" + "description": "> [!NOTE] > This Parameter is only available on Windows." }, { "name": "-Value", @@ -135,14 +145,7 @@ } ], "isRequired": true, - "description": "Specifies the content to be added. Type a quoted string, such as **This data is for internal use only , or specify an object that contains content, such as the DateTime** object that `Get-Date` generates.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the content to be added. Type a quoted string, such as This data is for internal use only, or specify an object that contains content, such as the DateTime object that `Get-Date` generates." }, { "name": [ @@ -329,7 +332,7 @@ }, { "name": "-Value", - "description": "Specifies the content to be added. Type a quoted string, such as **This data is for internal use only , or specify an object that contains content, such as the DateTime** object that `Get-Date` generates.\n" + "description": "Specifies the content to be added. Type a quoted string, such as This data is for internal use only, or specify an object that contains content, such as the DateTime object that `Get-Date` generates." } ], "description": "Adds content to the specified items, such as adding words to a file.", diff --git a/command-signatures/json/autogenerated/powershell/add-history.json b/command-signatures/json/autogenerated/powershell/add-history.json index f1f29a73..720a19b2 100644 --- a/command-signatures/json/autogenerated/powershell/add-history.json +++ b/command-signatures/json/autogenerated/powershell/add-history.json @@ -11,7 +11,7 @@ "description": "Specifies an array of entries to add to the history as HistoryInfo object to the session history. You can use this parameter to submit a HistoryInfo object, such as the ones that are returned by the `Get-History`, `Import-Clixml`, or `Import-Csv` cmdlets, to `Add-History`." }, { - "name": "-Passthru", + "name": "-PassThru", "description": "Indicates that this cmdlet returns a HistoryInfo object for each history entry. By default, this cmdlet does not generate any output." }, { diff --git a/command-signatures/json/autogenerated/powershell/add-jobtrigger.json b/command-signatures/json/autogenerated/powershell/add-jobtrigger.json new file mode 100644 index 00000000..ec8d16cd --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-jobtrigger.json @@ -0,0 +1,182 @@ +{ + "name": "Add-JobTrigger", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Add-JobTrigger", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-kdsrootkey.json b/command-signatures/json/autogenerated/powershell/add-kdsrootkey.json new file mode 100644 index 00000000..87238f1e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-kdsrootkey.json @@ -0,0 +1,219 @@ +{ + "name": "Add-KdsRootKey", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-EffectiveImmediately", + "isRequired": true, + "description": "Indicates that the Microsoft Group Key Distribution Service immediately uses the new root key." + }, + { + "name": "-EffectiveTime", + "args": [ + { + "name": "DateTime" + } + ], + "description": "Specifies the date on which the newly generated root key takes effect. If this parameter is not specified, the default date set is 10 days after the current date." + }, + { + "name": "-LocalTestOnly", + "description": "Indicates that the new root key is generated on the local host only. This parameter is used with the Set-KdsConfiguration cmdlet to test the local server configuration." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-EffectiveTime", + "description": "Specifies the date on which the newly generated root key takes effect. If this parameter is not specified, the default date set is 10 days after the current date." + } + ], + "description": "Generates a new root key for the Microsoft Group KdsSvc within Active Directory.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-localgroupmember.json b/command-signatures/json/autogenerated/powershell/add-localgroupmember.json new file mode 100644 index 00000000..7f86e5a1 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-localgroupmember.json @@ -0,0 +1,244 @@ +{ + "name": "Add-LocalGroupMember", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Group", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.LocalGroup" + } + ], + "isRequired": true, + "description": "Specifies the security group to which this cmdlet adds members." + }, + { + "name": "-Member", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.LocalPrincipal[]" + } + ], + "isRequired": true, + "description": "Specifies an array of users or groups that this cmdlet adds to a security group. You can specify users or groups by name, security ID (SID), or LocalPrincipal objects." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the security group to which this cmdlet adds members." + }, + { + "name": "-SID", + "args": [ + { + "name": "System.Security.Principal.SecurityIdentifier" + } + ], + "isRequired": true, + "description": "Specifies the security ID of the security group to which this cmdlet adds members." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Group-Or-Name-Or-SID" + }, + { + "name": "-Member", + "description": "Specifies an array of users or groups that this cmdlet adds to a security group. You can specify users or groups by name, security ID (SID), or LocalPrincipal objects." + } + ], + "description": "Adds members to a local group.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-member.json b/command-signatures/json/autogenerated/powershell/add-member.json index 3672e2d2..b23b4041 100644 --- a/command-signatures/json/autogenerated/powershell/add-member.json +++ b/command-signatures/json/autogenerated/powershell/add-member.json @@ -27,15 +27,48 @@ { "name": "AliasProperty" }, + { + "name": "All" + }, { "name": "CodeMethod" }, { "name": "CodeProperty" }, + { + "name": "Dynamic" + }, + { + "name": "Event" + }, + { + "name": "InferredProperty" + }, + { + "name": "MemberSet" + }, + { + "name": "Method" + }, + { + "name": "Methods" + }, { "name": "NoteProperty" }, + { + "name": "ParameterizedProperty" + }, + { + "name": "Properties" + }, + { + "name": "Property" + }, + { + "name": "PropertySet" + }, { "name": "ScriptMethod" }, @@ -46,7 +79,7 @@ } ], "isRequired": true, - "description": "Specifies the type of the member to add. This parameter is required. The acceptable values for this parameter are:\n" + "description": "Specifies the type of the member to add. This parameter is required. The acceptable values for this parameter are:" }, { "name": "-Name", @@ -66,7 +99,7 @@ } ], "isRequired": true, - "description": "Specifies a hashtable or ordered dictionary that contains key-value pair representing NoteProperty names and their values. For more information about hash tables and ordered dictionaries in PowerShell, see about_Hash_Tables (../Microsoft.PowerShell.Core/About/about_Hash_Tables.md).\n" + "description": "Specifies a hashtable or ordered dictionary that contains key-value pair representing NoteProperty names and their values. For more information about hash tables and ordered dictionaries in PowerShell, see [about_Hash_Tables](../Microsoft.PowerShell.Core/About/about_Hash_Tables.md)." }, { "name": "-NotePropertyName", @@ -76,7 +109,7 @@ } ], "isRequired": true, - "description": "Specifies the note property name.\n" + "description": "Specifies the note property name." }, { "name": "-NotePropertyValue", @@ -86,11 +119,11 @@ } ], "isRequired": true, - "description": "Specifies the note property value.\n" + "description": "Specifies the note property value." }, { "name": "-PassThru", - "description": "Returns an object representing the item with which you are working. By default, this cmdlet doesn't generate any output.\n" + "description": "Returns an object representing the item with which you are working. By default, this cmdlet doesn't generate any output." }, { "name": "-SecondValue", @@ -99,7 +132,7 @@ "name": "System.Object" } ], - "description": "Specifies optional additional information about AliasProperty , ScriptProperty , or CodeProperty members.\n" + "description": "Specifies optional additional information about AliasProperty, ScriptProperty, or CodeProperty members." }, { "name": "-TypeName", @@ -108,7 +141,8 @@ "name": "System.String" } ], - "description": "Specifies a name for the type.\n" + "isRequired": true, + "description": "Specifies a name for the type." }, { "name": "-Value", @@ -117,7 +151,7 @@ "name": "System.Object" } ], - "description": "Specifies the initial value of the added member. If you add an AliasProperty , CodeProperty , or ScriptProperty member, you can supply additional information using the SecondValue parameter.\n" + "description": "Specifies the initial value of the added member. If you add an AliasProperty, CodeProperty, or ScriptProperty member, you can supply additional information using the SecondValue parameter." }, { "name": [ @@ -299,11 +333,11 @@ }, { "name": "-Value", - "description": "Specifies the initial value of the added member. If you add an AliasProperty , CodeProperty , or ScriptProperty member, you can supply additional information using the SecondValue parameter.\n" + "description": "Specifies the initial value of the added member. If you add an AliasProperty, CodeProperty, or ScriptProperty member, you can supply additional information using the SecondValue parameter." }, { "name": "-SecondValue", - "description": "Specifies optional additional information about AliasProperty , ScriptProperty , or CodeProperty members.\n" + "description": "Specifies optional additional information about AliasProperty, ScriptProperty, or CodeProperty members." } ], "description": "Adds custom properties and methods to an instance of a PowerShell object.", diff --git a/command-signatures/json/autogenerated/powershell/add-type.json b/command-signatures/json/autogenerated/powershell/add-type.json index 75e3b43b..ded3ea5b 100644 --- a/command-signatures/json/autogenerated/powershell/add-type.json +++ b/command-signatures/json/autogenerated/powershell/add-type.json @@ -12,7 +12,7 @@ } ], "isRequired": true, - "description": "Specifies the name of an assembly that includes the types. `Add-Type` takes the types from the specified assembly. This parameter is required when you're creating types based on an assembly name.\n" + "description": "Specifies the name of an assembly that includes the types. `Add-Type` takes the types from the specified assembly. This parameter is required when you're creating types based on an assembly name." }, { "name": "-CompilerOptions", @@ -21,7 +21,7 @@ "name": "System.String[]" } ], - "description": "Specifies the options for the source code compiler. These options are sent to the compiler without revision.\n" + "description": "Specifies the options for the source code compiler. These options are sent to the compiler without revision." }, { "name": "-IgnoreWarnings", @@ -36,11 +36,10 @@ { "name": "CSharp" } - ], - "default": "CSharp" + ] } ], - "description": "Specifies the language that is used in the source code. The acceptable value for this parameter is `CSharp`." + "description": "Specifies the language that's used in the source code. The acceptable value for this parameter is `CSharp`." }, { "name": [ @@ -54,7 +53,7 @@ } ], "isRequired": true, - "description": "Specifies the path to source code files or assembly DLL files that contain the types. Unlike Path , the value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies the path to source code files or assembly DLL files that contain the types. Unlike Path, the value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-MemberDefinition", @@ -64,7 +63,7 @@ } ], "isRequired": true, - "description": "Specifies new properties or methods for the class. `Add-Type` generates the template code that is required to support the properties or methods.\n" + "description": "Specifies new properties or methods for the class. `Add-Type` generates the template code that's required to support the properties or methods." }, { "name": "-Name", @@ -74,7 +73,7 @@ } ], "isRequired": true, - "description": "Specifies the name of the class to create. This parameter is required when generating a type from a member definition.\n" + "description": "Specifies the name of the class to create. This parameter is required when generating a type from a member definition." }, { "name": [ @@ -86,7 +85,7 @@ "name": "System.String" } ], - "description": "Specifies a namespace for the type.\n" + "description": "By default, this command creates the type in the Microsoft.PowerShell.Commands.AddType.AutoGeneratedTypes namespace. When you use this parameter, the type is created in the specified namespace. If the value an empty string, the type is created in the global namespace." }, { "name": [ @@ -98,7 +97,7 @@ "name": "System.String" } ], - "description": "Generates a DLL file for the assembly with the specified name in the location. Enter an optional path and filename. Wildcard characters are permitted. By default, `Add-Type` generates the assembly only in memory." + "description": "Generates a DLL file for the assembly with the specified name in the location. Enter an optional path and filename. Wildcard characters are permitted. By default, `Add-Type` generates the assembly only in memory. If you output the assembly to a file you should include the PassThru parameter to return the type from the newly created assembly." }, { "name": [ @@ -121,11 +120,11 @@ ] } ], - "description": "Specifies the output type of the output assembly. By default, no output type is specified. This parameter is valid only when an output assembly is specified in the command. For more information about the values, see OutputAssemblyType Enumeration (/dotnet/api/microsoft.powershell.commands.outputassemblytype).\n" + "description": "Specifies the output type of the output assembly. By default, no output type is specified. This parameter is valid only when an output assembly is specified in the command. For more information about the values, see [OutputAssemblyType Enumeration](xref:Microsoft.PowerShell.Commands.OutputAssemblyType)." }, { "name": "-PassThru", - "description": "Returns a System.Runtime object that represents the types that were added. By default, this cmdlet doesn't generate any output." + "description": "Returns a System.Runtime object that represents the types that were added. By default, this cmdlet doesn't generate any output. Use this parameter if you used OutputAssembly to create a DLL file and you want to return the type from the newly created assembly." }, { "name": "-Path", @@ -135,7 +134,7 @@ } ], "isRequired": true, - "description": "Specifies the path to source code files or assembly DLL files that contain the types.\n" + "description": "Specifies the path to source code files or assembly DLL files that contain the types." }, { "name": [ @@ -147,7 +146,7 @@ "name": "System.String[]" } ], - "description": "Specifies the assemblies upon which the type depends. By default, `Add-Type` references `System.dll` and `System.Management.Automation.dll`. The assemblies that you specify by using this parameter are referenced in addition to the default assemblies.\n" + "description": "Specifies the assemblies upon which the type depends. By default, `Add-Type` references `System.dll` and `System.Management.Automation.dll`. Beginning in PowerShell 6, ReferencedAssemblies doesn't include the default .NET assemblies. You must include a specific reference to them in the value passed to this parameter." }, { "name": "-TypeDefinition", @@ -157,7 +156,7 @@ } ], "isRequired": true, - "description": "Specifies the source code that contains the type definitions. Enter the source code in a string or here-string, or enter a variable that contains the source code. For more information about here-strings, see about_Quoting_Rules (../Microsoft.PowerShell.Core/about/about_Quoting_Rules.md).\n" + "description": "Specifies the source code that contains the type definitions. Enter the source code in a string or here-string, or enter a variable that contains the source code. For more information about here-strings, see [about_Quoting_Rules](../Microsoft.PowerShell.Core/About/about_Quoting_Rules.md)." }, { "name": [ @@ -166,11 +165,10 @@ ], "args": [ { - "name": "System.String[]", - "default": "System namespace" + "name": "System.String[]" } ], - "description": "Specifies other namespaces that are required for the class. This is much like the C# keyword, `Using`.\n" + "description": "Specifies other namespaces that are required for the class. This is much like the C# keyword, `Using`." }, { "name": [ @@ -349,7 +347,7 @@ }, { "name": "-MemberDefinition", - "description": "Specifies new properties or methods for the class. `Add-Type` generates the template code that is required to support the properties or methods.\n" + "description": "Specifies new properties or methods for the class. `Add-Type` generates the template code that's required to support the properties or methods." } ], "description": "Adds a Microsoft .NET class to a PowerShell session.", diff --git a/command-signatures/json/autogenerated/powershell/add-windowscapability.json b/command-signatures/json/autogenerated/powershell/add-windowscapability.json new file mode 100644 index 00000000..a35bf7d6 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-windowscapability.json @@ -0,0 +1,285 @@ +{ + "name": "Add-WindowsCapability", + "options": [ + { + "name": "-LimitAccess", + "description": "Indicates that this cmdlet does not query Windows Update for source packages when servicing a live OS. Only applies when the `-Online` switch is specified." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs." + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `\"$env:WINDIR\\Logs\\Dism\\dism.log\"`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Name", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the identity of the capability to add to an operating system image." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Indicates that the cmdlet operates on a running operating system on the local host." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\"$env:Temp\"` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-Source", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies the location of the files that are required to add a Windows capability package to an image. If you specify multiple *Source* arguments, the files are gathered from the first location where they are found and the rest of the locations are ignored. Separate source locations with a comma." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Installs a Windows capability package on the specified operating system image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-windowsdriver.json b/command-signatures/json/autogenerated/powershell/add-windowsdriver.json new file mode 100644 index 00000000..991914a2 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-windowsdriver.json @@ -0,0 +1,292 @@ +{ + "name": "Add-WindowsDriver", + "options": [ + { + "name": "-AdvancedDriverObject", + "args": [ + { + "name": "AdvancedDriverObject" + } + ], + "description": "Specifies an object containing detailed information about the driver you want to add. This can be piped from the output of Export-WindowsDriver or Get-WindowsDriver." + }, + { + "name": "-BasicDriverObject", + "args": [ + { + "name": "BasicDriverObject" + } + ], + "description": "Provides an object containing basic information about the driver you want to add. This can be piped from the output of Export-WindowsDriver or Get-WindowsDriver." + }, + { + "name": "-Driver", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the .inf file or folder containing the .inf files of the drivers you want to add. When you specify a folder, .inf files that are not valid driver packages are ignored. These files are reported on the console when the command runs, and a warning is included in the log file. You will not receive an error message." + }, + { + "name": "-ForceUnsigned", + "description": "Adds unsigned drivers to an x64 image. The *ForceUnsigned* parameter overrides the requirement that drivers that are installed on X64-based computers must have a digital signature. For more information about driver signing requirements, see [Windows Deployment Options](https://go.microsoft.com/fwlink/?LinkId=214574) in the TechNet Library." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-Recurse", + "description": "Includes all subfolders when searching for drivers to add." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Adds a driver to an offline Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-windowsimage.json b/command-signatures/json/autogenerated/powershell/add-windowsimage.json new file mode 100644 index 00000000..6f6ef342 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-windowsimage.json @@ -0,0 +1,301 @@ +{ + "name": "Add-WindowsImage", + "options": [ + { + "name": "-CapturePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the path to the location of the new files that will be compared to the resources in the existing .wim file." + }, + { + "name": "-CheckIntegrity", + "description": "Detects and tracks .wim file corruption when used with the Add-WindowsImage, Dismount-WindowsImage, or Save-WindowsImage cmdlet. CheckIntegrity stops the operation if DISM detects that the .wim file is corrupted when used with the Expand-WindowsImage or Mount-WindowsImage cmdlet." + }, + { + "name": "-ConfigFilePath", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location of a configuration file that lists exclusions for image capture and compress commands. For more information, see [DISM Configuration List and WimScript.ini Files](https://go.microsoft.com/fwlink/?LinkID=313768)." + }, + { + "name": "-Description", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the description of the image to be captured." + }, + { + "name": "-ImagePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location of the WIM file containing the Windows image you want to compare against the new files." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Name", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the name of an image in a WIM file." + }, + { + "name": "-NoRpFix", + "description": "Disables the reparse point tag fix. A reparse point is a file that contains a link to another file on the file system. If the parameter is not specified, reparse points that resolve to paths outside of the value specified by the *ImagePath* parameter will not be captured." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-Setbootable", + "description": "Marks a volume image as being a bootable image. This argument is available only for Windows PE images. Only one volume image can be marked as bootable in a .wim file." + }, + { + "name": "-SupportEa", + "description": "Appends an image with extended attributes." + }, + { + "name": "-Verify", + "description": "Checks for errors and file duplication. During an apply operation, for example, using the Add-WindowsImage cmdlet, the size and the hash of the file being applied are checked against the image file to verify they are both equal. During a capture operation, for example, when using the New-WindowsImage cmdlet, after the files is captured into a Windows image, the file is written to a temporary file and compared on a bit-by-bit basis with the original file." + }, + { + "name": "-WIMBoot", + "description": "Specifies that the offline image to be added will be formatted to install on a Windows Image Format Boot (WIMBoot) system." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Adds an additional image to an existing image (.wim) file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/add-windowspackage.json b/command-signatures/json/autogenerated/powershell/add-windowspackage.json new file mode 100644 index 00000000..a912fbb5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/add-windowspackage.json @@ -0,0 +1,284 @@ +{ + "name": "Add-WindowsPackage", + "options": [ + { + "name": "-IgnoreCheck", + "description": "Skips the applicability check for each package." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-NoRestart", + "description": "Suppresses reboot. If a reboot is not required, this command does nothing. This option will keep the application from prompting for a restart or keep it from restarting automatically." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-PackagePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location of the package to add to the image." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-PreventPending", + "description": "Skips the installation of the package if the package or Windows image has pending online actions." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Adds a single .cab or .msu file to a Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/checkpoint-computer.json b/command-signatures/json/autogenerated/powershell/checkpoint-computer.json new file mode 100644 index 00000000..45717887 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/checkpoint-computer.json @@ -0,0 +1,243 @@ +{ + "name": "Checkpoint-Computer", + "options": [ + { + "name": "-Description", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-RestorePointType", + "-RPT" + ], + "args": [ + { + "name": "string", + "suggestions": [ + { + "name": "APPLICATION_INSTALL" + }, + { + "name": "APPLICATION_UNINSTALL" + }, + { + "name": "DEVICE_DRIVER_INSTALL" + }, + { + "name": "MODIFY_SETTINGS" + }, + { + "name": "CANCELLED_OPERATION" + } + ] + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Description" + }, + { + "name": "-RestorePointType", + "suggestions": [ + { + "name": "APPLICATION_INSTALL" + }, + { + "name": "APPLICATION_UNINSTALL" + }, + { + "name": "DEVICE_DRIVER_INSTALL" + }, + { + "name": "MODIFY_SETTINGS" + }, + { + "name": "CANCELLED_OPERATION" + } + ] + } + ], + "description": "Checkpoint-Computer [-Description] [[-RestorePointType] ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/clear-content.json b/command-signatures/json/autogenerated/powershell/clear-content.json index ca203e8a..1576f32e 100644 --- a/command-signatures/json/autogenerated/powershell/clear-content.json +++ b/command-signatures/json/autogenerated/powershell/clear-content.json @@ -1,14 +1,21 @@ { "name": "Clear-Content", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. To impersonate another > user, or elevate your credentials when running this cmdlet, use `Invoke-Command`." }, { "name": "-Exclude", @@ -63,7 +70,7 @@ } ], "isRequired": true, - "description": "Specifies the paths to the items from which content is deleted. Wildcards are permitted. The paths must be paths to items, not to containers. For example, you must specify a path to one or more files, not a path to a directory. Wildcards are permitted. This parameter is required, but the parameter name ( Path ) is optional." + "description": "Specifies the paths to the items from which content is deleted. Wildcards are permitted. The paths must be paths to items, not to containers. For example, you must specify a path to one or more files, not a path to a directory. Wildcards are permitted. This parameter is required, but the parameter name (Path) is optional." }, { "name": "-Stream", @@ -72,14 +79,7 @@ "name": "System.String" } ], - "description": "This is a dynamic parameter made available by the FileSystem provider. This parameter is only available on Windows.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "This is a dynamic parameter made available by the FileSystem provider. This parameter is only available on Windows." }, { "name": [ @@ -262,7 +262,7 @@ "args": [ { "name": "-Path", - "description": "Specifies the paths to the items from which content is deleted. Wildcards are permitted. The paths must be paths to items, not to containers. For example, you must specify a path to one or more files, not a path to a directory. Wildcards are permitted. This parameter is required, but the parameter name ( Path ) is optional." + "description": "Specifies the paths to the items from which content is deleted. Wildcards are permitted. The paths must be paths to items, not to containers. For example, you must specify a path to one or more files, not a path to a directory. Wildcards are permitted. This parameter is required, but the parameter name (Path) is optional." } ], "description": "Deletes the contents of an item, but does not delete the item.", diff --git a/command-signatures/json/autogenerated/powershell/clear-eventlog.json b/command-signatures/json/autogenerated/powershell/clear-eventlog.json new file mode 100644 index 00000000..aca85f58 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/clear-eventlog.json @@ -0,0 +1,224 @@ +{ + "name": "Clear-EventLog", + "options": [ + { + "name": [ + "-ComputerName", + "-Cn" + ], + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": [ + "-LogName", + "-LN" + ], + "args": [ + { + "name": "string[]" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-LogName" + }, + { + "name": "-ComputerName" + } + ], + "description": "Clear-EventLog [-LogName] [[-ComputerName] ] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/clear-history.json b/command-signatures/json/autogenerated/powershell/clear-history.json index 17fcf8b4..6316e8cb 100644 --- a/command-signatures/json/autogenerated/powershell/clear-history.json +++ b/command-signatures/json/autogenerated/powershell/clear-history.json @@ -8,7 +8,14 @@ "name": "System.String[]" } ], - "description": "Deletes command history from a PowerShell session. The string must be an exact match or use wildcards to match commands in the PowerShell session history displayed by `Get-History`. If you enter more than one string, `Clear-History` deletes commands that match any of the strings. The CommandLine parameter can be used with Count .\n" + "description": "Deletes command history from a PowerShell session. The string must be an exact match or use wildcards to match commands in the PowerShell session history displayed by `Get-History`. If you enter more than one string, `Clear-History` deletes commands that match any of the strings. The CommandLine parameter can be used with Count." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the `Clear-History` cmdlet." }, { "name": "-Count", @@ -17,7 +24,7 @@ "name": "System.Int32" } ], - "description": "Specifies the number of history entries that `Clear-History` deletes. Commands are deleted in order, beginning with the oldest entry in the history.\n" + "description": "Specifies the number of history entries that `Clear-History` deletes. Commands are deleted in order, beginning with the oldest entry in the history." }, { "name": "-Id", @@ -26,18 +33,11 @@ "name": "System.Int32[]" } ], - "description": "Specifies the command history Id that `Clear-History` deletes. To display Id numbers, use the `Get-History` cmdlet. The Id numbers are sequential and commands keep their Id number throughout a PowerShell session. The Id parameter can be used with Count and Newest ." + "description": "Specifies the command history Id that `Clear-History` deletes. To display Id numbers, use the `Get-History` cmdlet. The Id numbers are sequential and commands keep their Id number throughout a PowerShell session. The Id parameter can be used with Count and Newest." }, { "name": "-Newest", - "description": "When the Newest parameter is used, `Clear-History` deletes the newest entries in the history. By default, `Clear-History` deletes the oldest entries in the history.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the `Clear-History` cmdlet." + "description": "When the Newest parameter is used, `Clear-History` deletes the newest entries in the history. By default, `Clear-History` deletes the oldest entries in the history." }, { "name": [ @@ -220,11 +220,11 @@ "args": [ { "name": "-Id", - "description": "Specifies the command history Id that `Clear-History` deletes. To display Id numbers, use the `Get-History` cmdlet. The Id numbers are sequential and commands keep their Id number throughout a PowerShell session. The Id parameter can be used with Count and Newest ." + "description": "Specifies the command history Id that `Clear-History` deletes. To display Id numbers, use the `Get-History` cmdlet. The Id numbers are sequential and commands keep their Id number throughout a PowerShell session. The Id parameter can be used with Count and Newest." }, { "name": "-Count", - "description": "Specifies the number of history entries that `Clear-History` deletes. Commands are deleted in order, beginning with the oldest entry in the history.\n" + "description": "Specifies the number of history entries that `Clear-History` deletes. Commands are deleted in order, beginning with the oldest entry in the history." } ], "description": "Deletes entries from the PowerShell session command history.", diff --git a/command-signatures/json/autogenerated/powershell/clear-item.json b/command-signatures/json/autogenerated/powershell/clear-item.json index f863ed5a..d407dc7b 100644 --- a/command-signatures/json/autogenerated/powershell/clear-item.json +++ b/command-signatures/json/autogenerated/powershell/clear-item.json @@ -1,14 +1,21 @@ { "name": "Clear-Item", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Exclude", @@ -17,7 +24,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -26,11 +33,11 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Force", - "description": "Indicates that the cmdlet clears items that cannot otherwise be changed, such as read- only aliases. The cmdlet cannot clear constants. Implementation varies from provider to provider. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md). The cmdlet cannot override security restrictions, even when the Force parameter is used." + "description": "Indicates that the cmdlet clears items that cannot otherwise be changed, such as read- only aliases. The cmdlet cannot clear constants. Implementation varies from provider to provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md). The cmdlet cannot override security restrictions, even when the Force parameter is used." }, { "name": "-Include", @@ -39,7 +46,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -53,7 +60,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Path", @@ -65,13 +72,6 @@ "isRequired": true, "description": "Specifies the path to the items being cleared. Wildcard characters are permitted. This parameter is required, but the parameter name Path is optional." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/clear-itemproperty.json b/command-signatures/json/autogenerated/powershell/clear-itemproperty.json index 890682f4..bfd5eb0c 100644 --- a/command-signatures/json/autogenerated/powershell/clear-itemproperty.json +++ b/command-signatures/json/autogenerated/powershell/clear-itemproperty.json @@ -1,14 +1,21 @@ { "name": "Clear-ItemProperty", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Exclude", @@ -17,7 +24,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -26,11 +33,11 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Force", - "description": "Indicates that this cmdlet deletes properties from items that cannot otherwise be accessed by the user. Implementation varies from provider to provider. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md)." + "description": "Indicates that this cmdlet deletes properties from items that cannot otherwise be accessed by the user. Implementation varies from provider to provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md)." }, { "name": "-Include", @@ -39,7 +46,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -53,7 +60,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Name", @@ -79,13 +86,6 @@ "isRequired": true, "description": "Specifies the path to the property being cleared. Wildcard characters are permitted." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/clear-kdscache.json b/command-signatures/json/autogenerated/powershell/clear-kdscache.json new file mode 100644 index 00000000..8d2e872c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/clear-kdscache.json @@ -0,0 +1,205 @@ +{ + "name": "Clear-KdsCache", + "options": [ + { + "name": "-CacheOwnerSid", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the security identifier (SID) for the user account whose cache this cmdlet clears." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Clears the group key cache of the local computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/clear-recyclebin.json b/command-signatures/json/autogenerated/powershell/clear-recyclebin.json new file mode 100644 index 00000000..2e9c4a73 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/clear-recyclebin.json @@ -0,0 +1,214 @@ +{ + "name": "Clear-RecycleBin", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts for user confirmation before running the cmdlet. The user is prompted for confirmation even if the Confirm parameter isn't specified." + }, + { + "name": "-DriveLetter", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the recycle bin to clear for a single drive letter or an array of drive letters." + }, + { + "name": "-Force", + "description": "Specifies that the user isn't prompted for confirmation to clear a recycle bin. The Force parameter also overrides the WhatIf and Confirm parameters." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if `Clear-RecycleBin` runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-DriveLetter", + "description": "Specifies the recycle bin to clear for a single drive letter or an array of drive letters." + } + ], + "description": "Clears the contents of the current user's recycle bin.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/clear-refsdedupschedule.json b/command-signatures/json/autogenerated/powershell/clear-refsdedupschedule.json new file mode 100644 index 00000000..91662eb9 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/clear-refsdedupschedule.json @@ -0,0 +1,195 @@ +{ + "name": "Clear-ReFSDedupSchedule", + "options": [ + { + "name": "-Volume", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Clear-ReFSDedupSchedule [-Volume] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/clear-refsdedupscrubschedule.json b/command-signatures/json/autogenerated/powershell/clear-refsdedupscrubschedule.json new file mode 100644 index 00000000..4bfeeb3a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/clear-refsdedupscrubschedule.json @@ -0,0 +1,195 @@ +{ + "name": "Clear-ReFSDedupScrubSchedule", + "options": [ + { + "name": "-Volume", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Clear-ReFSDedupScrubSchedule [-Volume] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/clear-tpm.json b/command-signatures/json/autogenerated/powershell/clear-tpm.json new file mode 100644 index 00000000..386ffa8f --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/clear-tpm.json @@ -0,0 +1,216 @@ +{ + "name": "Clear-Tpm", + "options": [ + { + "name": "-File", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a file that contains the current owner authorization value for the TPM. You can use the TPM Management Console to create this file." + }, + { + "name": [ + "-OwnerAuthorization", + "-o" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the current owner authorization value for the TPM." + }, + { + "name": [ + "-UsePPI", + "-ppi" + ], + "description": "Use the PPI for the TPM reset. Restart the system for the changes to take effect. The restart might require user input to approve the clear request." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-OwnerAuthorization", + "description": "Specifies the current owner authorization value for the TPM." + } + ], + "description": "Resets a TPM to its default state.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/clear-variable.json b/command-signatures/json/autogenerated/powershell/clear-variable.json index 602f6736..e6d75e5f 100644 --- a/command-signatures/json/autogenerated/powershell/clear-variable.json +++ b/command-signatures/json/autogenerated/powershell/clear-variable.json @@ -1,6 +1,13 @@ { "name": "Clear-Variable", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Exclude", "args": [ @@ -45,14 +52,7 @@ "name": "System.String" } ], - "description": "Specifies the scope in which this alias is valid.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the scope in which this alias is valid." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/clear-windowscorruptmountpoint.json b/command-signatures/json/autogenerated/powershell/clear-windowscorruptmountpoint.json new file mode 100644 index 00000000..89450332 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/clear-windowscorruptmountpoint.json @@ -0,0 +1,229 @@ +{ + "name": "Clear-WindowsCorruptMountPoint", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Deletes all of the resources associated with a mounted image that has been corrupted.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/compare-object.json b/command-signatures/json/autogenerated/powershell/compare-object.json index db211e50..51eb65a1 100644 --- a/command-signatures/json/autogenerated/powershell/compare-object.json +++ b/command-signatures/json/autogenerated/powershell/compare-object.json @@ -26,11 +26,11 @@ }, { "name": "-ExcludeDifferent", - "description": "Indicates that this cmdlet displays only the characteristics of compared objects that are equal. The differences between the objects are discarded.\n" + "description": "Indicates that this cmdlet displays only the characteristics of compared objects that are equal. The differences between the objects are discarded." }, { "name": "-IncludeEqual", - "description": "IncludeEqual displays the matches between the reference and difference objects.\n" + "description": "IncludeEqual displays the matches between the reference and difference objects." }, { "name": "-PassThru", @@ -43,7 +43,7 @@ "name": "System.Object[]" } ], - "description": "Specifies an array of properties of the reference and difference objects to compare.\n" + "description": "Specifies an array of properties of the reference and difference objects to compare." }, { "name": "-ReferenceObject", @@ -59,11 +59,10 @@ "name": "-SyncWindow", "args": [ { - "name": "System.Int32", - "default": "[Int32]::MaxValue" + "name": "System.Int32" } ], - "description": "Specifies the number of adjacent objects that `Compare-Object` inspects while looking for a match in a collection of objects. `Compare-Object` examines adjacent objects when it doesn't find the object in the same position in a collection. The default value is `[Int32]::MaxValue`, which means that `Compare-Object` examines the entire object collection.\n" + "description": "Specifies the number of adjacent objects that `Compare-Object` inspects while looking for a match in a collection of objects. `Compare-Object` examines adjacent objects when it doesn't find the object in the same position in a collection. The default value is `[int32]::MaxValue`, which means that `Compare-Object` examines the entire object collection." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/complete-bitstransfer.json b/command-signatures/json/autogenerated/powershell/complete-bitstransfer.json new file mode 100644 index 00000000..558a3566 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/complete-bitstransfer.json @@ -0,0 +1,214 @@ +{ + "name": "Complete-BitsTransfer", + "options": [ + { + "name": [ + "-BitsJob", + "-b" + ], + "args": [ + { + "name": "BitsJob[]" + } + ], + "isRequired": true, + "description": "Specifies the BITS transfer jobs to complete. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as Get-BitsTransfer." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-BitsJob", + "description": "Specifies the BITS transfer jobs to complete. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as Get-BitsTransfer." + } + ], + "description": "Completes a BITS transfer job.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/complete-dtcdiagnostictransaction.json b/command-signatures/json/autogenerated/powershell/complete-dtcdiagnostictransaction.json new file mode 100644 index 00000000..10212cdc --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/complete-dtcdiagnostictransaction.json @@ -0,0 +1,195 @@ +{ + "name": "Complete-DtcDiagnosticTransaction", + "options": [ + { + "name": "-Transaction", + "args": [ + { + "name": "DtcDiagnosticTransaction" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Transaction" + } + ], + "description": "Complete-DtcDiagnosticTransaction [-Transaction] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/complete-transaction.json b/command-signatures/json/autogenerated/powershell/complete-transaction.json new file mode 100644 index 00000000..e6a4e7fc --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/complete-transaction.json @@ -0,0 +1,194 @@ +{ + "name": "Complete-Transaction", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Complete-Transaction [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/compress-psresource.json b/command-signatures/json/autogenerated/powershell/compress-psresource.json new file mode 100644 index 00000000..218fef6b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/compress-psresource.json @@ -0,0 +1,233 @@ +{ + "name": "Compress-PSResource", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-DestinationPath", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Path to save the compressed resource." + }, + { + "name": "-PassThru", + "description": "Pass the full path of the nupkg through the pipeline." + }, + { + "name": "-Path", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Path to the resource to be compressed." + }, + { + "name": "-SkipModuleManifestValidate", + "description": "Skips validating the module manifest before creating the `.nupkg` file." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path", + "description": "Path to the resource to be compressed." + }, + { + "name": "-DestinationPath", + "description": "Path to save the compressed resource." + } + ], + "description": "Compresses a specified folder containing module or script resources into a `.nupkg` file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/confirm-securebootuefi.json b/command-signatures/json/autogenerated/powershell/confirm-securebootuefi.json new file mode 100644 index 00000000..cca6020d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/confirm-securebootuefi.json @@ -0,0 +1,182 @@ +{ + "name": "Confirm-SecureBootUEFI", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Confirms that Secure Boot is enabled by checking the Secure Boot status on the local computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/connect-pssession.json b/command-signatures/json/autogenerated/powershell/connect-pssession.json new file mode 100644 index 00000000..2c5e3196 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/connect-pssession.json @@ -0,0 +1,370 @@ +{ + "name": "Connect-PSSession", + "options": [ + { + "name": "-AllowRedirection", + "description": "Indicates that this cmdlet allows redirection of this connection to an alternate URI." + }, + { + "name": "-ApplicationName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of an application. This cmdlet connects only to sessions that use the specified application." + }, + { + "name": "-Authentication", + "args": [ + { + "name": "System.Management.Automation.Runspaces.AuthenticationMechanism", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "Credssp" + }, + { + "name": "Default" + }, + { + "name": "Digest" + }, + { + "name": "Kerberos" + }, + { + "name": "Negotiate" + }, + { + "name": "NegotiateWithImplicitCredential" + } + ] + } + ], + "description": "Specifies the mechanism that is used to authenticate user credentials in the command to reconnect to the disconnected session. The acceptable values for this parameter are:" + }, + { + "name": "-CertificateThumbprint", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to connect to the disconnected session. Enter the certificate thumbprint of the certificate." + }, + { + "name": [ + "-ComputerName", + "-Cn" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the computers on which the disconnected sessions are stored. Sessions are stored on the computer that is at the server-side or receiving end of a connection. The default is the local computer." + }, + { + "name": "-ConfigurationName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Connects only to sessions that use the specified session configuration." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-ConnectionUri", + "-URI", + "-CU" + ], + "args": [ + { + "name": "System.Uri[]" + } + ], + "isRequired": true, + "description": "Specifies the URIs of the connection endpoints for the disconnected sessions." + }, + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to connect to the disconnected session. The default is the current user." + }, + { + "name": "-Id", + "args": [ + { + "name": "System.Int32[]" + } + ], + "isRequired": true, + "description": "Specifies the IDs of the disconnected sessions. The Id parameter works only when the disconnected session was previously connected to the current session." + }, + { + "name": "-InstanceId", + "args": [ + { + "name": "System.Guid[]" + } + ], + "isRequired": true, + "description": "Specifies the instance IDs of the disconnected sessions." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the friendly names of the disconnected sessions." + }, + { + "name": "-Port", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies the network port on the remote computer that is used to reconnect to the session. To connect to a remote computer, the remote computer must be listening on the port that the connection uses. The default ports are `5985`, which is the WinRM port for HTTP, and `5986`, which is the WinRM port for HTTPS." + }, + { + "name": "-Session", + "args": [ + { + "name": "System.Management.Automation.Runspaces.PSSession[]" + } + ], + "isRequired": true, + "description": "Specifies the disconnected sessions. Enter a variable that contains the PSSession objects or a command that creates or gets the PSSession objects, such as a `Get-PSSession` command." + }, + { + "name": "-SessionOption", + "args": [ + { + "name": "System.Management.Automation.Remoting.PSSessionOption" + } + ], + "description": "Specifies advanced options for the session. Enter a SessionOption object, such as one that you create by using the `New-PSSessionOption` cmdlet, or a hash table in which the keys are session option names and the values are session option values." + }, + { + "name": "-ThrottleLimit", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this parameter or enter a value of `0`, the default value, `32`, is used." + }, + { + "name": "-UseSSL", + "description": "Indicates that this cmdlet uses the Secure Sockets Layer (SSL) protocol to connect to the disconnected session. By default, SSL is not used." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ConnectionUri-Or-Id-Or-Session" + } + ], + "description": "Reconnects to disconnected sessions.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/connect-wsman.json b/command-signatures/json/autogenerated/powershell/connect-wsman.json new file mode 100644 index 00000000..e27f6506 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/connect-wsman.json @@ -0,0 +1,315 @@ +{ + "name": "Connect-WSMan", + "options": [ + { + "name": "-ApplicationName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the application name in the connection. The default value of the ApplicationName parameter is WSMAN. The complete identifier for the remote endpoint is in the following format:" + }, + { + "name": [ + "-Authentication", + "-auth", + "-am" + ], + "args": [ + { + "name": "Microsoft.WSMan.Management.AuthenticationMechanism", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "ClientCertificate" + }, + { + "name": "Credssp" + }, + { + "name": "Default" + }, + { + "name": "Digest" + }, + { + "name": "Kerberos" + }, + { + "name": "Negotiate" + }, + { + "name": "None" + } + ] + } + ], + "description": "Specifies the authentication mechanism to be used at the server. The acceptable values for this parameter are:" + }, + { + "name": "-CertificateThumbprint", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to perform this action. Enter the certificate thumbprint of the certificate." + }, + { + "name": [ + "-ComputerName", + "-cn" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the computer against which to run the management operation. The value can be a fully qualified domain name, a NetBIOS name, or an IP address. Use the local computer name, use localhost, or use a dot (`.`) to specify the local computer. The local computer is the default. When the remote computer is in a different domain from the user, you must use a fully qualified domain name must be used. You can pipe a value for this parameter to the cmdlet." + }, + { + "name": "-ConnectionURI", + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the connection endpoint. The format of this string is as follows:" + }, + { + "name": [ + "-Credential", + "-cred", + "-c" + ], + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to perform this action. The default is the current user. Type a user name, such as `User01`, `Domain01\\User01`, or `User@Domain.com`. Or, enter a PSCredential object, such as one returned by the `Get-Credential` cmdlet. When you type a user name, this cmdlet prompts you for a password." + }, + { + "name": [ + "-OptionSet", + "-os" + ], + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "description": "Specifies a set of switches to a service to modify or refine the nature of the request. These resemble switches used in command-line shells because they are service specific. Any number of options can be specified." + }, + { + "name": "-Port", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies the port to use when the client connects to the WinRM service. When the transport is HTTP, the default port is 80. When the transport is HTTPS, the default port is 443." + }, + { + "name": [ + "-SessionOption", + "-so" + ], + "args": [ + { + "name": "Microsoft.WSMan.Management.SessionOption" + } + ], + "description": "Specifies extended options for the WS-Management session. Enter a SessionOption object that you create by using the `New-WSManSessionOption` cmdlet. For more information about the options that are available, type `Get-Help New-WSManSessionOption`." + }, + { + "name": "-UseSSL", + "description": "Specifies that the Secure Sockets Layer (SSL) protocol is used to establish a connection to the remote computer. By default, SSL is not used." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ComputerName", + "description": "Specifies the computer against which to run the management operation. The value can be a fully qualified domain name, a NetBIOS name, or an IP address. Use the local computer name, use localhost, or use a dot (`.`) to specify the local computer. The local computer is the default. When the remote computer is in a different domain from the user, you must use a fully qualified domain name must be used. You can pipe a value for this parameter to the cmdlet." + } + ], + "description": "Connects to the WinRM service on a remote computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/convert-path.json b/command-signatures/json/autogenerated/powershell/convert-path.json index 39c98fe7..9dbb9f7a 100644 --- a/command-signatures/json/autogenerated/powershell/convert-path.json +++ b/command-signatures/json/autogenerated/powershell/convert-path.json @@ -1,6 +1,10 @@ { "name": "Convert-Path", "options": [ + { + "name": "-Force", + "description": "Allows the cmdlet to get items that otherwise can't be accessed by the user, such as hidden or system files. The Force parameter doesn't override security restrictions. Implementation varies among providers. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md)." + }, { "name": [ "-LiteralPath", @@ -13,7 +17,7 @@ } ], "isRequired": true, - "description": "Specifies, as a string array, the path to be converted. The value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies, as a string array, the path to be converted. The value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Path", diff --git a/command-signatures/json/autogenerated/powershell/convertfrom-clixml.json b/command-signatures/json/autogenerated/powershell/convertfrom-clixml.json new file mode 100644 index 00000000..10955292 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/convertfrom-clixml.json @@ -0,0 +1,197 @@ +{ + "name": "ConvertFrom-CliXml", + "options": [ + { + "name": "-InputObject", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "The object containing a CliXml-formatted string to be converted." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject", + "description": "The object containing a CliXml-formatted string to be converted." + } + ], + "description": "Converts a CliXml-formatted string to a custom PSObject.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/convertfrom-csv.json b/command-signatures/json/autogenerated/powershell/convertfrom-csv.json index 925ce94b..febfb5e5 100644 --- a/command-signatures/json/autogenerated/powershell/convertfrom-csv.json +++ b/command-signatures/json/autogenerated/powershell/convertfrom-csv.json @@ -5,11 +5,10 @@ "name": "-Delimiter", "args": [ { - "name": "System.Char", - "default": "comma (,)" + "name": "System.Char" } ], - "description": "Specifies the delimiter that separates the property values in the CSV strings. The default is a comma (`,`). Enter a character, such as a colon (`:`). To specify a semicolon (`;`) enclose it in single quotation marks.\n" + "description": "Specifies the delimiter that separates the property values in the CSV data. The default is a comma (`,`)." }, { "name": "-Header", @@ -18,7 +17,7 @@ "name": "System.String[]" } ], - "description": "Specifies an alternate column header row for the imported string. The column header determines the property names of the objects created by `ConvertFrom-Csv`.\n" + "description": "Specifies an alternate column header row for the imported string. The column header determines the property names of the objects created by `ConvertFrom-Csv`." }, { "name": "-InputObject", @@ -213,7 +212,7 @@ }, { "name": "-Delimiter", - "description": "Specifies the delimiter that separates the property values in the CSV strings. The default is a comma (`,`). Enter a character, such as a colon (`:`). To specify a semicolon (`;`) enclose it in single quotation marks.\n" + "description": "Specifies the delimiter that separates the property values in the CSV data. The default is a comma (`,`)." } ], "description": "Converts object properties in character-separated value (CSV) format into CSV versions of the original objects.", diff --git a/command-signatures/json/autogenerated/powershell/convertfrom-json.json b/command-signatures/json/autogenerated/powershell/convertfrom-json.json index 3b31b275..6a82cdc1 100644 --- a/command-signatures/json/autogenerated/powershell/convertfrom-json.json +++ b/command-signatures/json/autogenerated/powershell/convertfrom-json.json @@ -3,7 +3,33 @@ "options": [ { "name": "-AsHashtable", - "description": "Converts the JSON to a hash table object. This switch was introduced in PowerShell 6.0. Starting with PowerShell 7.3, the object is an OrderedHashtable and preserves the ordering of the keys from the JSON. In prior versions, the object is a Hashtable .\n" + "description": "Converts the JSON to a hash table object. This switch was introduced in PowerShell 6.0. Starting with PowerShell 7.3, the object is an OrderedHashtable and preserves the ordering of the keys from the JSON. In prior versions, the object is a Hashtable." + }, + { + "name": "-DateKind", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.JsonDateKind", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "Local" + }, + { + "name": "Offset" + }, + { + "name": "String" + }, + { + "name": "Utc" + } + ] + } + ], + "description": "Specifies the method used when parsing date time values in the JSON string. The acceptable values for this parameter are:" }, { "name": "-Depth", @@ -12,7 +38,7 @@ "name": "System.Int32" } ], - "description": "Gets or sets the maximum depth the JSON input is allowed to have. The default is 1024.\n" + "description": "Gets or sets the maximum depth the JSON input is allowed to have. The default is 1024." }, { "name": "-InputObject", @@ -22,11 +48,11 @@ } ], "isRequired": true, - "description": "Specifies the JSON strings to convert to JSON objects. Enter a variable that contains the string, or type a command or expression that gets the string. You can also pipe a string to `ConvertFrom-Json`.\n" + "description": "Specifies the JSON strings to convert to JSON objects. Enter a variable that contains the string, or type a command or expression that gets the string. You can also pipe a string to `ConvertFrom-Json`." }, { "name": "-NoEnumerate", - "description": "Specifies that output isn't enumerated.\n" + "description": "Specifies that output isn't enumerated." }, { "name": [ @@ -202,7 +228,7 @@ "args": [ { "name": "-InputObject", - "description": "Specifies the JSON strings to convert to JSON objects. Enter a variable that contains the string, or type a command or expression that gets the string. You can also pipe a string to `ConvertFrom-Json`.\n" + "description": "Specifies the JSON strings to convert to JSON objects. Enter a variable that contains the string, or type a command or expression that gets the string. You can also pipe a string to `ConvertFrom-Json`." } ], "description": "Converts a JSON-formatted string to a custom object or a hash table.", diff --git a/command-signatures/json/autogenerated/powershell/convertfrom-sddlstring.json b/command-signatures/json/autogenerated/powershell/convertfrom-sddlstring.json new file mode 100644 index 00000000..ea57ed60 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/convertfrom-sddlstring.json @@ -0,0 +1,226 @@ +{ + "name": "ConvertFrom-SddlString", + "options": [ + { + "name": "-Sddl", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the string representing the security descriptor in SDDL syntax." + }, + { + "name": "-Type", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.ConvertFromSddlStringCommand+AccessRightTypeNames", + "suggestions": [ + { + "name": "ActiveDirectoryRights" + }, + { + "name": "EventWaitHandleRights" + }, + { + "name": "FileSystemRights" + }, + { + "name": "MutexRights" + }, + { + "name": "RegistryRights" + }, + { + "name": "SemaphoreRights" + } + ] + } + ], + "description": "Specifies the type of rights that SDDL string represents." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Sddl", + "description": "Specifies the string representing the security descriptor in SDDL syntax." + } + ], + "description": "Converts a SDDL string to a custom object.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/convertfrom-securestring.json b/command-signatures/json/autogenerated/powershell/convertfrom-securestring.json index 2d4c2f24..d80556a7 100644 --- a/command-signatures/json/autogenerated/powershell/convertfrom-securestring.json +++ b/command-signatures/json/autogenerated/powershell/convertfrom-securestring.json @@ -3,7 +3,7 @@ "options": [ { "name": "-AsPlainText", - "description": "When set, `ConvertFrom-SecureString` will convert secure strings to the decrypted plaintext string as output.\n" + "description": "When set, `ConvertFrom-SecureString` will convert secure strings to the decrypted plaintext string as output." }, { "name": "-Key", diff --git a/command-signatures/json/autogenerated/powershell/convertfrom-stringdata.json b/command-signatures/json/autogenerated/powershell/convertfrom-stringdata.json index e00c0f11..83eead38 100644 --- a/command-signatures/json/autogenerated/powershell/convertfrom-stringdata.json +++ b/command-signatures/json/autogenerated/powershell/convertfrom-stringdata.json @@ -5,8 +5,7 @@ "name": "-Delimiter", "args": [ { - "name": "System.Char", - "default": "'='" + "name": "System.Char" } ], "description": "The character used to separate the key from the value data in the string being converted. The default delimiter is the equals sign (`=`) character. This parameter was added in PowerShell 7." @@ -19,7 +18,7 @@ } ], "isRequired": true, - "description": "Specifies the string to be converted. You can use this parameter or pipe a string to `ConvertFrom-StringData`. The parameter name is optional.\n" + "description": "Specifies the string to be converted. You can use this parameter or pipe a string to `ConvertFrom-StringData`. The parameter name is optional." }, { "name": [ @@ -195,7 +194,7 @@ "args": [ { "name": "-StringData", - "description": "Specifies the string to be converted. You can use this parameter or pipe a string to `ConvertFrom-StringData`. The parameter name is optional.\n" + "description": "Specifies the string to be converted. You can use this parameter or pipe a string to `ConvertFrom-StringData`. The parameter name is optional." }, { "name": "-Delimiter", diff --git a/command-signatures/json/autogenerated/powershell/convertto-clixml.json b/command-signatures/json/autogenerated/powershell/convertto-clixml.json new file mode 100644 index 00000000..c754f230 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/convertto-clixml.json @@ -0,0 +1,206 @@ +{ + "name": "ConvertTo-CliXml", + "options": [ + { + "name": "-Depth", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies how many levels of contained objects are included in the XML representation. The default values is 2." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "System.Management.Automation.PSObject" + } + ], + "isRequired": true, + "description": "The object to be converted to a CliXml-formatted string." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject", + "description": "The object to be converted to a CliXml-formatted string." + } + ], + "description": "Converts an object to a CliXml-formatted string.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/convertto-csv.json b/command-signatures/json/autogenerated/powershell/convertto-csv.json index 46d0128b..ccdb4f40 100644 --- a/command-signatures/json/autogenerated/powershell/convertto-csv.json +++ b/command-signatures/json/autogenerated/powershell/convertto-csv.json @@ -5,18 +5,17 @@ "name": "-Delimiter", "args": [ { - "name": "System.Char", - "default": "comma (,)" + "name": "System.Char" } ], - "description": "Specifies the delimiter to separate the property values in CSV strings. The default is a comma (`,`). Enter a character, such as a colon (`:`). To specify a semicolon (`;`) enclose it in single quotation marks." + "description": "Specifies the delimiter to separate the property values in CSV strings. The default is a comma (`,`)." }, { "name": [ "-IncludeTypeInformation", "-ITI" ], - "description": "When this parameter is used the first line of the output contains `#TYPE` followed by the fully qualified name of the object type. For example, `#TYPE System.Diagnostics.Process`.\n" + "description": "When this parameter is used the first line of the output contains `#TYPE` followed by the fully qualified name of the object type. For example, `#TYPE System.Diagnostics.Process`." }, { "name": "-InputObject", @@ -26,7 +25,11 @@ } ], "isRequired": true, - "description": "Specifies the objects that are converted to CSV strings. Enter a variable that contains the objects or type a command or expression that gets the objects. You can also pipe objects to `ConvertTo-CSV`." + "description": "Specifies the objects that are converted to CSV strings. Enter a variable that contains the objects or type a command or expression that gets the objects. You can also pipe objects to `ConvertTo-Csv`." + }, + { + "name": "-NoHeader", + "description": "When this parameter is used, the cmdlet doesn't write a header row containing the column names to the output." }, { "name": [ @@ -59,10 +62,20 @@ "args": [ { "name": "Microsoft.PowerShell.Commands.BaseCsvWritingCommand+QuoteKind", - "default": "Always" + "suggestions": [ + { + "name": "Always" + }, + { + "name": "AsNeeded" + }, + { + "name": "Never" + } + ] } ], - "description": "Specifies when quotes are used in the CSV files. Possible values are:\n" + "description": "Specifies when quotes are used in the CSV files. Possible values are:" }, { "name": [ @@ -238,11 +251,11 @@ "args": [ { "name": "-InputObject", - "description": "Specifies the objects that are converted to CSV strings. Enter a variable that contains the objects or type a command or expression that gets the objects. You can also pipe objects to `ConvertTo-CSV`." + "description": "Specifies the objects that are converted to CSV strings. Enter a variable that contains the objects or type a command or expression that gets the objects. You can also pipe objects to `ConvertTo-Csv`." }, { "name": "-Delimiter", - "description": "Specifies the delimiter to separate the property values in CSV strings. The default is a comma (`,`). Enter a character, such as a colon (`:`). To specify a semicolon (`;`) enclose it in single quotation marks." + "description": "Specifies the delimiter to separate the property values in CSV strings. The default is a comma (`,`)." } ], "description": "Converts .NET objects into a series of character-separated value (CSV) strings.", diff --git a/command-signatures/json/autogenerated/powershell/convertto-html.json b/command-signatures/json/autogenerated/powershell/convertto-html.json index 8a70ba61..ca6fb7cf 100644 --- a/command-signatures/json/autogenerated/powershell/convertto-html.json +++ b/command-signatures/json/autogenerated/powershell/convertto-html.json @@ -8,15 +8,15 @@ "name": "System.String", "suggestions": [ { - "name": "Table" + "name": "List" }, { - "name": "List" + "name": "Table" } ] } ], - "description": "Determines whether the object is formatted as a table or a list. Valid values are Table and List . The default value is Table .\n" + "description": "Determines whether the object is formatted as a table or a list. Valid values are Table and List. The default value is Table." }, { "name": "-Body", @@ -34,7 +34,7 @@ "name": "System.String" } ], - "description": "Specifies text to add to the opening `` tag. By default, there is no text in that position.\n" + "description": "Specifies text to add to the opening `` tag. By default, there is no text in that position." }, { "name": [ @@ -60,7 +60,7 @@ "name": "System.String[]" } ], - "description": "Specifies the content of the `` tag. The default is `HTML TABLE`. If you use the Head parameter, the Title parameter is ignored." + "description": "Specifies the content of the `` tag. The default is `HTML TABLE`. If you use the Head parameter, the Title parameter is ignored." }, { "name": "-InputObject", @@ -69,7 +69,7 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies the objects to be represented in HTML. Enter a variable that contains the objects or type a command or expression that gets the objects.\n" + "description": "Specifies the objects to be represented in HTML. Enter a variable that contains the objects or type a command or expression that gets the objects." }, { "name": "-Meta", @@ -78,7 +78,7 @@ "name": "System.Collections.Hashtable" } ], - "description": "Specifies text to add to the opening `` tag. By default, there is no text in that position.\n" + "description": "Specifies text to add to the opening `` tag. By default, there is no text in that position." }, { "name": "-PostContent", @@ -105,7 +105,7 @@ "name": "System.Object[]" } ], - "description": "Includes the specified properties of the objects in the HTML. The value of the Property parameter can be a new calculated property. The calculated property can be a script block or a hash table. Valid key-value pairs are:\n" + "description": "Includes the specified properties of the objects in the HTML. The value of the Property parameter can be a new calculated property. The calculated property can be a scriptblock or a hash table. Valid key-value pairs are:" }, { "name": "-Title", @@ -118,7 +118,7 @@ }, { "name": "-Transitional", - "description": "Changes the `DOCTYPE` to XHTML Transitional DTD , Default `DOCTYPE` is XHTML Strict DTD .\n" + "description": "Changes the `DOCTYPE` to XHTML Transitional DTD, Default `DOCTYPE` is XHTML Strict DTD." }, { "name": [ @@ -294,11 +294,11 @@ "args": [ { "name": "-Property", - "description": "Includes the specified properties of the objects in the HTML. The value of the Property parameter can be a new calculated property. The calculated property can be a script block or a hash table. Valid key-value pairs are:\n" + "description": "Includes the specified properties of the objects in the HTML. The value of the Property parameter can be a new calculated property. The calculated property can be a scriptblock or a hash table. Valid key-value pairs are:" }, { "name": "-Head", - "description": "Specifies the content of the `` tag. The default is `HTML TABLE`. If you use the Head parameter, the Title parameter is ignored." + "description": "Specifies the content of the `` tag. The default is `HTML TABLE`. If you use the Head parameter, the Title parameter is ignored." }, { "name": "-Title", diff --git a/command-signatures/json/autogenerated/powershell/convertto-json.json b/command-signatures/json/autogenerated/powershell/convertto-json.json index f9404af0..78f71668 100644 --- a/command-signatures/json/autogenerated/powershell/convertto-json.json +++ b/command-signatures/json/autogenerated/powershell/convertto-json.json @@ -13,8 +13,7 @@ "name": "-Depth", "args": [ { - "name": "System.Int32", - "default": "2" + "name": "System.Int32" } ], "description": "Specifies how many levels of contained objects are included in the JSON representation. The value can be any number from `0` to `100`. The default value is `2`. `ConvertTo-Json` emits a warning if the number of levels in an input object exceeds this number." @@ -28,10 +27,20 @@ "args": [ { "name": "Newtonsoft.Json.StringEscapeHandling", - "default": "Default" + "suggestions": [ + { + "name": "Default" + }, + { + "name": "EscapeHtml" + }, + { + "name": "EscapeNonAscii" + } + ] } ], - "description": "Controls how certain characters are escaped in the resulting JSON output. By default, only control characters (like newline) are escaped.\n" + "description": "Controls how certain characters are escaped in the resulting JSON output. By default, only control characters (like newline) are escaped." }, { "name": "-InputObject", @@ -41,7 +50,7 @@ } ], "isRequired": true, - "description": "Specifies the objects to convert to JSON format. Enter a variable that contains the objects, or type a command or expression that gets the objects. You can also pipe an object to `ConvertTo-Json`.\n" + "description": "Specifies the objects to convert to JSON format. Enter a variable that contains the objects, or type a command or expression that gets the objects. You can also pipe an object to `ConvertTo-Json`." }, { "name": [ @@ -217,7 +226,7 @@ "args": [ { "name": "-InputObject", - "description": "Specifies the objects to convert to JSON format. Enter a variable that contains the objects, or type a command or expression that gets the objects. You can also pipe an object to `ConvertTo-Json`.\n" + "description": "Specifies the objects to convert to JSON format. Enter a variable that contains the objects, or type a command or expression that gets the objects. You can also pipe an object to `ConvertTo-Json`." } ], "description": "Converts an object to a JSON-formatted string.", diff --git a/command-signatures/json/autogenerated/powershell/convertto-processmitigationpolicy.json b/command-signatures/json/autogenerated/powershell/convertto-processmitigationpolicy.json new file mode 100644 index 00000000..1efebc6b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/convertto-processmitigationpolicy.json @@ -0,0 +1,217 @@ +{ + "name": "ConvertTo-ProcessMitigationPolicy", + "options": [ + { + "name": [ + "-EMETFilePath", + "-f" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path of the Enhanced Mitigation Experience Tool (EMET) file to convert." + }, + { + "name": [ + "-OutputFilePath", + "-o" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path of the converted format file." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-EMETFilePath", + "description": "Specifies the full path of the Enhanced Mitigation Experience Tool (EMET) file to convert." + }, + { + "name": "-OutputFilePath", + "description": "Specifies the full path of the converted format file." + } + ], + "description": "Converts an mitigation policy file formats.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/convertto-tpmownerauth.json b/command-signatures/json/autogenerated/powershell/convertto-tpmownerauth.json new file mode 100644 index 00000000..1a507105 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/convertto-tpmownerauth.json @@ -0,0 +1,197 @@ +{ + "name": "ConvertTo-TpmOwnerAuth", + "options": [ + { + "name": "-PassPhrase", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a pass phrase string. This cmdlet converts the pass phrase to an owner authorization value." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-PassPhrase", + "description": "Specifies a pass phrase string. This cmdlet converts the pass phrase to an owner authorization value." + } + ], + "description": "Creates a TPM owner authorization value from a supplied string.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/convertto-xml.json b/command-signatures/json/autogenerated/powershell/convertto-xml.json index 95e08d0f..8b18cc81 100644 --- a/command-signatures/json/autogenerated/powershell/convertto-xml.json +++ b/command-signatures/json/autogenerated/powershell/convertto-xml.json @@ -8,18 +8,18 @@ "name": "System.String", "suggestions": [ { - "name": "Stream" + "name": "Document" }, { - "name": "String" + "name": "Stream" }, { - "name": "Document" + "name": "String" } ] } ], - "description": "Determines the output format. The acceptable values for this parameter are:\n" + "description": "Determines the output format. The acceptable values for this parameter are:" }, { "name": "-Depth", @@ -28,7 +28,7 @@ "name": "System.Int32" } ], - "description": "Specifies how many levels of contained objects are included in the XML representation. The default value is 1.\n" + "description": "Specifies how many levels of contained objects are included in the XML representation. The default value is 1." }, { "name": "-InputObject", @@ -38,7 +38,7 @@ } ], "isRequired": true, - "description": "Specifies the object to be converted. Enter a variable that contains the objects, or type a command or expression that gets the objects. You can also pipe objects to `ConvertTo-XML`." + "description": "Specifies the object to be converted. Enter a variable that contains the objects, or type a command or expression that gets the objects. You can also pipe objects to `ConvertTo-Xml`." }, { "name": "-NoTypeInformation", @@ -218,7 +218,7 @@ "args": [ { "name": "-InputObject", - "description": "Specifies the object to be converted. Enter a variable that contains the objects, or type a command or expression that gets the objects. You can also pipe objects to `ConvertTo-XML`." + "description": "Specifies the object to be converted. Enter a variable that contains the objects, or type a command or expression that gets the objects. You can also pipe objects to `ConvertTo-Xml`." } ], "description": "Creates an XML-based representation of an object.", diff --git a/command-signatures/json/autogenerated/powershell/copy-bcdentry.json b/command-signatures/json/autogenerated/powershell/copy-bcdentry.json new file mode 100644 index 00000000..2eff6ddb --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/copy-bcdentry.json @@ -0,0 +1,252 @@ +{ + "name": "Copy-BcdEntry", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Description", + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill Description Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": "-SourceEntry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill SourceEntry Description }}" + }, + { + "name": "-SourceEntryId", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill SourceEntryId Description }}" + }, + { + "name": "-SourceStore", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill SourceStore Description }}" + }, + { + "name": "-TargetStore", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo[]" + } + ], + "isRequired": true, + "description": "{{ Fill TargetStore Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-SourceEntry-Or-SourceEntryId" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/copy-item.json b/command-signatures/json/autogenerated/powershell/copy-item.json index c19d62ad..80baf41c 100644 --- a/command-signatures/json/autogenerated/powershell/copy-item.json +++ b/command-signatures/json/autogenerated/powershell/copy-item.json @@ -1,28 +1,34 @@ { "name": "Copy-Item", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Container", - "description": "Indicates that this cmdlet preserves container objects during the copy operation. By default, the Container parameter is set to True ." + "description": "Indicates that this cmdlet preserves container objects during the copy operation. By default, the Container parameter is set to True." }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter isn't supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Destination", "args": [ { - "name": "System.String", - "default": "Current directory" + "name": "System.String" } ], - "description": "Specifies the path to the new location. The default is the current directory.\n" + "description": "Specifies the path to the new location. The default is the current directory." }, { "name": "-Exclude", @@ -40,7 +46,7 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved." }, { "name": "-Force", @@ -53,7 +59,7 @@ "name": "System.Management.Automation.Runspaces.PSSession" } ], - "description": "This is a dynamic parameter made available by the FileSystem provider.\n" + "description": "This is a dynamic parameter made available by the FileSystem provider." }, { "name": "-Include", @@ -76,7 +82,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-PassThru", @@ -103,14 +109,7 @@ "name": "System.Management.Automation.Runspaces.PSSession" } ], - "description": "This is a dynamic parameter made available by the FileSystem provider.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "This is a dynamic parameter made available by the FileSystem provider." }, { "name": [ @@ -297,7 +296,7 @@ }, { "name": "-Destination", - "description": "Specifies the path to the new location. The default is the current directory.\n" + "description": "Specifies the path to the new location. The default is the current directory." } ], "description": "Copies an item from one location to another.", diff --git a/command-signatures/json/autogenerated/powershell/copy-itemproperty.json b/command-signatures/json/autogenerated/powershell/copy-itemproperty.json index 4d26c883..0d984342 100644 --- a/command-signatures/json/autogenerated/powershell/copy-itemproperty.json +++ b/command-signatures/json/autogenerated/powershell/copy-itemproperty.json @@ -1,14 +1,21 @@ { "name": "Copy-ItemProperty", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Destination", @@ -27,7 +34,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -36,11 +43,11 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Force", - "description": "Forces the command to run without asking for user confirmation. Implementation varies from provider to provider.\n" + "description": "Forces the command to run without asking for user confirmation. Implementation varies from provider to provider." }, { "name": "-Include", @@ -49,7 +56,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -63,7 +70,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": [ @@ -92,13 +99,6 @@ "isRequired": true, "description": "Specifies, as a string array, the path to the property to be copied. Wildcard characters are permitted." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/copy-userinternationalsettingstosystem.json b/command-signatures/json/autogenerated/powershell/copy-userinternationalsettingstosystem.json new file mode 100644 index 00000000..bbc04870 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/copy-userinternationalsettingstosystem.json @@ -0,0 +1,202 @@ +{ + "name": "Copy-UserInternationalSettingsToSystem", + "options": [ + { + "name": "-NewUser", + "args": [ + { + "name": "Boolean" + } + ], + "isRequired": true, + "description": "Copies the settings into the new user accounts." + }, + { + "name": "-WelcomeScreen", + "args": [ + { + "name": "Boolean" + } + ], + "isRequired": true, + "description": "Copies the settings into the Welcome screen and system accounts." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Copies the current user's international settings (Windows Display language, Input language, Regional Format/locale, and Location/GeoID) to one or both of the following: * Welcome screen and system accounts * New user accounts Important: Note that this PowerShell cmdlet is only available for Windows 11 and later. This is a system setting. It can only be changed by a user who has Administrator permissions. Changes take effect after the computer is restarted.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/debug-job.json b/command-signatures/json/autogenerated/powershell/debug-job.json index e3d69857..de302bc4 100644 --- a/command-signatures/json/autogenerated/powershell/debug-job.json +++ b/command-signatures/json/autogenerated/powershell/debug-job.json @@ -3,7 +3,14 @@ "options": [ { "name": "-BreakAll", - "description": "Allows you to break immediately in the current location when the debugger attaches.\n" + "description": "Allows you to break immediately in the current location when the debugger attaches." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-Id", @@ -45,13 +52,6 @@ "isRequired": true, "description": "Specifies a job by the friendly name of the job. When you start a job, you can specify a job name by adding the JobName parameter, in cmdlets such as `Invoke-Command` and `Start-Job`." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/debug-process.json b/command-signatures/json/autogenerated/powershell/debug-process.json index 77f3723c..68098b1b 100644 --- a/command-signatures/json/autogenerated/powershell/debug-process.json +++ b/command-signatures/json/autogenerated/powershell/debug-process.json @@ -1,6 +1,13 @@ { "name": "Debug-Process", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": [ "-Id", @@ -13,7 +20,7 @@ } ], "isRequired": true, - "description": "Specifies the process IDs of the processes to be debugged. The Id parameter name is optional.\n" + "description": "Specifies the process IDs of the processes to be debugged. The Id parameter name is optional." }, { "name": "-InputObject", @@ -39,13 +46,6 @@ "isRequired": true, "description": "Specifies the names of the processes to be debugged. If there is more than one process with the same name, this cmdlet attaches a debugger to all processes with that name. The Name parameter is optional." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/debug-runspace.json b/command-signatures/json/autogenerated/powershell/debug-runspace.json index 55a6825b..0432655c 100644 --- a/command-signatures/json/autogenerated/powershell/debug-runspace.json +++ b/command-signatures/json/autogenerated/powershell/debug-runspace.json @@ -3,7 +3,14 @@ "options": [ { "name": "-BreakAll", - "description": "Allows you to break immediately in the current location when the debugger attaches.\n" + "description": "Allows you to break immediately in the current location when the debugger attaches." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-Id", @@ -45,13 +52,6 @@ "isRequired": true, "description": "Specifies a runspace object. The simplest way to provide a value for this parameter is to specify a variable that contains the results of a filtered `Get-Runspace` command." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/disable-appbackgroundtaskdiagnosticlog.json b/command-signatures/json/autogenerated/powershell/disable-appbackgroundtaskdiagnosticlog.json new file mode 100644 index 00000000..2f471b67 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-appbackgroundtaskdiagnosticlog.json @@ -0,0 +1,196 @@ +{ + "name": "Disable-AppBackgroundTaskDiagnosticLog", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Disables background task logging in Event Viewer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-bcdelementbootdebug.json b/command-signatures/json/autogenerated/powershell/disable-bcdelementbootdebug.json new file mode 100644 index 00000000..3c198b43 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-bcdelementbootdebug.json @@ -0,0 +1,240 @@ +{ + "name": "Disable-BcdElementBootDebug", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-bcdelementbootems.json b/command-signatures/json/autogenerated/powershell/disable-bcdelementbootems.json new file mode 100644 index 00000000..425dafa7 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-bcdelementbootems.json @@ -0,0 +1,240 @@ +{ + "name": "Disable-BcdElementBootEms", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-bcdelementdebug.json b/command-signatures/json/autogenerated/powershell/disable-bcdelementdebug.json new file mode 100644 index 00000000..cf98aa5c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-bcdelementdebug.json @@ -0,0 +1,235 @@ +{ + "name": "Disable-BcdElementDebug", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-bcdelementems.json b/command-signatures/json/autogenerated/powershell/disable-bcdelementems.json new file mode 100644 index 00000000..55dd3582 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-bcdelementems.json @@ -0,0 +1,240 @@ +{ + "name": "Disable-BcdElementEms", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-bcdelementeventlogging.json b/command-signatures/json/autogenerated/powershell/disable-bcdelementeventlogging.json new file mode 100644 index 00000000..a7775593 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-bcdelementeventlogging.json @@ -0,0 +1,240 @@ +{ + "name": "Disable-BcdElementEventLogging", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-bcdelementhypervisordebug.json b/command-signatures/json/autogenerated/powershell/disable-bcdelementhypervisordebug.json new file mode 100644 index 00000000..9a6e7e04 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-bcdelementhypervisordebug.json @@ -0,0 +1,240 @@ +{ + "name": "Disable-BcdElementHypervisorDebug", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-computerrestore.json b/command-signatures/json/autogenerated/powershell/disable-computerrestore.json new file mode 100644 index 00000000..7c4a84f1 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-computerrestore.json @@ -0,0 +1,207 @@ +{ + "name": "Disable-ComputerRestore", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Drive", + "args": [ + { + "name": "string[]" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Drive" + } + ], + "description": "Disable-ComputerRestore [-Drive] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-experimentalfeature.json b/command-signatures/json/autogenerated/powershell/disable-experimentalfeature.json index 886456bd..38978f2b 100644 --- a/command-signatures/json/autogenerated/powershell/disable-experimentalfeature.json +++ b/command-signatures/json/autogenerated/powershell/disable-experimentalfeature.json @@ -1,6 +1,13 @@ { "name": "Disable-ExperimentalFeature", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Name", "args": [ @@ -23,19 +30,11 @@ { "name": "CurrentUser" } - ], - "default": "CurrentUser" + ] } ], "description": "Determines which `powershell.config.json` to update whether it affects all users or just the current user." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/disable-jobtrigger.json b/command-signatures/json/autogenerated/powershell/disable-jobtrigger.json new file mode 100644 index 00000000..35a26f5a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-jobtrigger.json @@ -0,0 +1,182 @@ +{ + "name": "Disable-JobTrigger", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Disable-JobTrigger", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-localuser.json b/command-signatures/json/autogenerated/powershell/disable-localuser.json new file mode 100644 index 00000000..be000188 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-localuser.json @@ -0,0 +1,230 @@ +{ + "name": "Disable-LocalUser", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.LocalUser[]" + } + ], + "isRequired": true, + "description": "Specifies an array of user accounts that this cmdlet disables. To obtain a user account, use the `Get-LocalUser` cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies an array of names of the user accounts that this cmdlet disables." + }, + { + "name": "-SID", + "args": [ + { + "name": "System.Security.Principal.SecurityIdentifier[]" + } + ], + "isRequired": true, + "description": "Specifies an array of user accounts that this cmdlet disables." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name-Or-SID" + } + ], + "description": "Disables a local user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-psbreakpoint.json b/command-signatures/json/autogenerated/powershell/disable-psbreakpoint.json index 7a02947f..04dd19bf 100644 --- a/command-signatures/json/autogenerated/powershell/disable-psbreakpoint.json +++ b/command-signatures/json/autogenerated/powershell/disable-psbreakpoint.json @@ -11,6 +11,13 @@ "isRequired": true, "description": "Specifies the breakpoints to disable. Enter a variable that contains breakpoint objects or a command that gets breakpoint objects, such as a `Get-PSBreakpoint` command. You can also pipe breakpoint objects to the `Disable-PSBreakpoint` cmdlet." }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Id", "args": [ @@ -35,14 +42,7 @@ "name": "Runspace" } ], - "description": "Specifies the Id of a Runspace object so you can interact with breakpoints in the specified runspace.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the Id of a Runspace object so you can interact with breakpoints in the specified runspace." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/disable-psremoting.json b/command-signatures/json/autogenerated/powershell/disable-psremoting.json new file mode 100644 index 00000000..eb08bae4 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-psremoting.json @@ -0,0 +1,200 @@ +{ + "name": "Disable-PSRemoting", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "Forces the command to run without asking for user confirmation." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Prevents PowerShell endpoints from receiving remote connections.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-pssessionconfiguration.json b/command-signatures/json/autogenerated/powershell/disable-pssessionconfiguration.json new file mode 100644 index 00000000..5d6f6ba4 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-pssessionconfiguration.json @@ -0,0 +1,218 @@ +{ + "name": "Disable-PSSessionConfiguration", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "Forces the command to run without asking for user confirmation." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies an array of names of session configurations to disable. Enter one or more configuration names. Wildcard characters are permitted. You can also pipe a string that contains a configuration name or a session configuration object to `Disable-PSSessionConfiguration`." + }, + { + "name": "-NoServiceRestart", + "description": "Used to prevent the restart of the WSMan service. It is not necessary to restart the service to disable the configuration." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies an array of names of session configurations to disable. Enter one or more configuration names. Wildcard characters are permitted. You can also pipe a string that contains a configuration name or a session configuration object to `Disable-PSSessionConfiguration`." + } + ], + "description": "Disables session configurations on the local computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-refsdedup.json b/command-signatures/json/autogenerated/powershell/disable-refsdedup.json new file mode 100644 index 00000000..7118f527 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-refsdedup.json @@ -0,0 +1,195 @@ +{ + "name": "Disable-ReFSDedup", + "options": [ + { + "name": "-Volume", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Disable-ReFSDedup [-Volume] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-scheduledjob.json b/command-signatures/json/autogenerated/powershell/disable-scheduledjob.json new file mode 100644 index 00000000..49c5cf32 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-scheduledjob.json @@ -0,0 +1,182 @@ +{ + "name": "Disable-ScheduledJob", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Disable-ScheduledJob", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-tlsciphersuite.json b/command-signatures/json/autogenerated/powershell/disable-tlsciphersuite.json new file mode 100644 index 00000000..6ecfcd4e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-tlsciphersuite.json @@ -0,0 +1,211 @@ +{ + "name": "Disable-TlsCipherSuite", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the TLS cipher suite to disable." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the name of the TLS cipher suite to disable." + } + ], + "description": "Disables a TLS cipher suite.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-tlsecccurve.json b/command-signatures/json/autogenerated/powershell/disable-tlsecccurve.json new file mode 100644 index 00000000..bd4ea1a5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-tlsecccurve.json @@ -0,0 +1,211 @@ +{ + "name": "Disable-TlsEccCurve", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the ECC curve to disable." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the name of the ECC curve to disable." + } + ], + "description": "Disables the Elliptic Curve Cryptography (ECC) cipher suites available for TLS(Transport Layer Security) for a computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-tlssessionticketkey.json b/command-signatures/json/autogenerated/powershell/disable-tlssessionticketkey.json new file mode 100644 index 00000000..413035d8 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-tlssessionticketkey.json @@ -0,0 +1,211 @@ +{ + "name": "Disable-TlsSessionTicketKey", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-ServiceAccountName", + "args": [ + { + "name": "System.Security.Principal.NTAccount" + } + ], + "isRequired": true, + "description": "Specifies the name of a service account. The cmdlet disables the TLS session ticket key for the service account. Only System, LocalService, NetworkService, and SID of virtual accounts are supported." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ServiceAccountName", + "description": "Specifies the name of a service account. The cmdlet disables the TLS session ticket key for the service account. Only System, LocalService, NetworkService, and SID of virtual accounts are supported." + } + ], + "description": "Disables a TLS session ticket key.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-tpmautoprovisioning.json b/command-signatures/json/autogenerated/powershell/disable-tpmautoprovisioning.json new file mode 100644 index 00000000..73558342 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-tpmautoprovisioning.json @@ -0,0 +1,189 @@ +{ + "name": "Disable-TpmAutoProvisioning", + "options": [ + { + "name": [ + "-OnlyForNextRestart", + "-b" + ], + "description": "Indicates that the cmdlet disables auto-provisioning only for the next computer restart. During the restart after that, auto-provisioning begins." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Disables TPM auto-provisioning.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-windowserrorreporting.json b/command-signatures/json/autogenerated/powershell/disable-windowserrorreporting.json new file mode 100644 index 00000000..10d2bfdc --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-windowserrorreporting.json @@ -0,0 +1,182 @@ +{ + "name": "Disable-WindowsErrorReporting", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Disables Windows Error Reporting.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-windowsoptionalfeature.json b/command-signatures/json/autogenerated/powershell/disable-windowsoptionalfeature.json new file mode 100644 index 00000000..d45e35d8 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-windowsoptionalfeature.json @@ -0,0 +1,289 @@ +{ + "name": "Disable-WindowsOptionalFeature", + "options": [ + { + "name": "-FeatureName", + "args": [ + { + "name": "String[]" + } + ], + "isRequired": true, + "description": "Specifies the name of the feature to be disabled. Feature names are case sensitive if you are servicing a Windows image other than Windows® 8 or a later version. You can use Get-WindowsOptionalFeature to find the name of the feature in the image." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-NoRestart", + "description": "Suppresses reboot. If a reboot is not required, this command does nothing. This option will keep the application from prompting for a restart or keep it from restarting automatically." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-PackageName", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of a package in the Windows image." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-Remove", + "description": "Removes the files for an optional feature without removing the feature's manifest from the image. You can use *Remove* to reduce the disk space that is used by a Windows image. After the image has been installed, you can restore the feature at any time from a remote source such as Windows Update or a network share." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Disables a feature in a Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disable-wsmancredssp.json b/command-signatures/json/autogenerated/powershell/disable-wsmancredssp.json new file mode 100644 index 00000000..b5c8afcb --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disable-wsmancredssp.json @@ -0,0 +1,213 @@ +{ + "name": "Disable-WSManCredSSP", + "options": [ + { + "name": "-Role", + "args": [ + { + "name": "System.String", + "suggestions": [ + { + "name": "Client" + }, + { + "name": "Server" + } + ] + } + ], + "isRequired": true, + "description": "Specifies whether to disable CredSSP as a client or as a server. The acceptable values for this parameter are: Client and Server." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Role", + "description": "Specifies whether to disable CredSSP as a client or as a server. The acceptable values for this parameter are: Client and Server.", + "suggestions": [ + { + "name": "Client" + }, + { + "name": "Server" + } + ] + } + ], + "description": "Disables CredSSP authentication on a computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disconnect-pssession.json b/command-signatures/json/autogenerated/powershell/disconnect-pssession.json new file mode 100644 index 00000000..fad4569a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disconnect-pssession.json @@ -0,0 +1,278 @@ +{ + "name": "Disconnect-PSSession", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Id", + "args": [ + { + "name": "System.Int32[]" + } + ], + "isRequired": true, + "description": "Disconnects from sessions with the specified session ID. Type one or more IDs (separated by commas), or use the range operator (`..`) to specify a range of IDs." + }, + { + "name": "-IdleTimeoutSec", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Changes the idle timeout value of the disconnected PSSession. Enter a value in seconds. The minimum value is `60` (1 minute)." + }, + { + "name": "-InstanceId", + "args": [ + { + "name": "System.Guid[]" + } + ], + "isRequired": true, + "description": "Disconnects from sessions with the specified instance IDs." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Disconnects from sessions with the specified friendly names. Wildcards are permitted." + }, + { + "name": "-OutputBufferingMode", + "args": [ + { + "name": "System.Management.Automation.Runspaces.OutputBufferingMode", + "suggestions": [ + { + "name": "Block" + }, + { + "name": "Drop" + }, + { + "name": "None" + } + ] + } + ], + "description": "Determines how command output is managed in the disconnected session when the output buffer is full. The default value is `Block`." + }, + { + "name": "-Session", + "args": [ + { + "name": "System.Management.Automation.Runspaces.PSSession[]" + } + ], + "isRequired": true, + "description": "Disconnects from the specified PSSessions. Enter PSSession objects, such as those that the `New-PSSession` cmdlet returns. You can also pipe a PSSession object to `Disconnect-PSSession`." + }, + { + "name": "-ThrottleLimit", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Sets the throttle limit for the `Disconnect-PSSession` command." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Id-Or-Session" + } + ], + "description": "Disconnects from a session.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/disconnect-wsman.json b/command-signatures/json/autogenerated/powershell/disconnect-wsman.json new file mode 100644 index 00000000..05de54ca --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/disconnect-wsman.json @@ -0,0 +1,196 @@ +{ + "name": "Disconnect-WSMan", + "options": [ + { + "name": "-ComputerName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the computer against which to run the management operation. The value can be a fully qualified domain name, a NetBIOS name, or an IP address. Use the local computer name, use localhost, or use a dot (`.`) to specify the local computer. The local computer is the default. When the remote computer is in a different domain from the user, you must use a fully qualified domain name must be used. You can pipe a value for this parameter to the cmdlet." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ComputerName", + "description": "Specifies the computer against which to run the management operation. The value can be a fully qualified domain name, a NetBIOS name, or an IP address. Use the local computer name, use localhost, or use a dot (`.`) to specify the local computer. The local computer is the default. When the remote computer is in a different domain from the user, you must use a fully qualified domain name must be used. You can pipe a value for this parameter to the cmdlet." + } + ], + "description": "Disconnects the client from the WinRM service on a remote computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/dismount-appxvolume.json b/command-signatures/json/autogenerated/powershell/dismount-appxvolume.json new file mode 100644 index 00000000..1bb5ee23 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/dismount-appxvolume.json @@ -0,0 +1,207 @@ +{ + "name": "Dismount-AppxVolume", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Volume", + "args": [ + { + "name": "AppxVolume[]" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Dismount-AppxVolume [-Volume] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/dismount-windowsimage.json b/command-signatures/json/autogenerated/powershell/dismount-windowsimage.json new file mode 100644 index 00000000..e06c51d5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/dismount-windowsimage.json @@ -0,0 +1,257 @@ +{ + "name": "Dismount-WindowsImage", + "options": [ + { + "name": "-Append", + "description": "Specifies the location of an existing .wim file to add the Windows image to when you dismount it instead of overwriting the existing image." + }, + { + "name": "-CheckIntegrity", + "description": "Detects and tracks .wim file corruption. *CheckIntegrity* stops the operation if DISM detects that the .wim file is corrupted when used with the Mount-WindowsImage cmdlet." + }, + { + "name": "-Discard", + "isRequired": true, + "description": "Discards the changes to a Windows image." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-Save", + "isRequired": true, + "description": "Saves the changes to a Windows image." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Dismounts a Windows image from the directory it is mapped to.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-appbackgroundtaskdiagnosticlog.json b/command-signatures/json/autogenerated/powershell/enable-appbackgroundtaskdiagnosticlog.json new file mode 100644 index 00000000..886435da --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-appbackgroundtaskdiagnosticlog.json @@ -0,0 +1,196 @@ +{ + "name": "Enable-AppBackgroundTaskDiagnosticLog", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Enables background task logging in Event Viewer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-bcdelementbootdebug.json b/command-signatures/json/autogenerated/powershell/enable-bcdelementbootdebug.json new file mode 100644 index 00000000..b7d5f6cc --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-bcdelementbootdebug.json @@ -0,0 +1,240 @@ +{ + "name": "Enable-BcdElementBootDebug", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-bcdelementbootems.json b/command-signatures/json/autogenerated/powershell/enable-bcdelementbootems.json new file mode 100644 index 00000000..35c55f88 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-bcdelementbootems.json @@ -0,0 +1,237 @@ +{ + "name": "Enable-BcdElementBootEms", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": "-Id", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-bcdelementdebug.json b/command-signatures/json/autogenerated/powershell/enable-bcdelementdebug.json new file mode 100644 index 00000000..58365bb4 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-bcdelementdebug.json @@ -0,0 +1,235 @@ +{ + "name": "Enable-BcdElementDebug", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-bcdelementems.json b/command-signatures/json/autogenerated/powershell/enable-bcdelementems.json new file mode 100644 index 00000000..c1362e7b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-bcdelementems.json @@ -0,0 +1,240 @@ +{ + "name": "Enable-BcdElementEms", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-bcdelementeventlogging.json b/command-signatures/json/autogenerated/powershell/enable-bcdelementeventlogging.json new file mode 100644 index 00000000..cb152149 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-bcdelementeventlogging.json @@ -0,0 +1,240 @@ +{ + "name": "Enable-BcdElementEventLogging", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-bcdelementhypervisordebug.json b/command-signatures/json/autogenerated/powershell/enable-bcdelementhypervisordebug.json new file mode 100644 index 00000000..aaee2c0c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-bcdelementhypervisordebug.json @@ -0,0 +1,240 @@ +{ + "name": "Enable-BcdElementHypervisorDebug", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-computerrestore.json b/command-signatures/json/autogenerated/powershell/enable-computerrestore.json new file mode 100644 index 00000000..d535b233 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-computerrestore.json @@ -0,0 +1,207 @@ +{ + "name": "Enable-ComputerRestore", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Drive", + "args": [ + { + "name": "string[]" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Drive" + } + ], + "description": "Enable-ComputerRestore [-Drive] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-experimentalfeature.json b/command-signatures/json/autogenerated/powershell/enable-experimentalfeature.json index 6eeb0919..cb34ee60 100644 --- a/command-signatures/json/autogenerated/powershell/enable-experimentalfeature.json +++ b/command-signatures/json/autogenerated/powershell/enable-experimentalfeature.json @@ -1,6 +1,13 @@ { "name": "Enable-ExperimentalFeature", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Name", "args": [ @@ -23,19 +30,11 @@ { "name": "CurrentUser" } - ], - "default": "CurrentUser" + ] } ], "description": "Determines which `powershell.config.json` to update whether it affects all users or just the current user." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/enable-jobtrigger.json b/command-signatures/json/autogenerated/powershell/enable-jobtrigger.json new file mode 100644 index 00000000..d1ea902c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-jobtrigger.json @@ -0,0 +1,182 @@ +{ + "name": "Enable-JobTrigger", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Enable-JobTrigger", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-localuser.json b/command-signatures/json/autogenerated/powershell/enable-localuser.json new file mode 100644 index 00000000..f7ac6d85 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-localuser.json @@ -0,0 +1,230 @@ +{ + "name": "Enable-LocalUser", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.LocalUser[]" + } + ], + "isRequired": true, + "description": "Specifies an array of user accounts that this cmdlet enables. To obtain a user account, use the `Get-LocalUser` cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies an array of names of the user accounts that this cmdlet enables." + }, + { + "name": "-SID", + "args": [ + { + "name": "System.Security.Principal.SecurityIdentifier[]" + } + ], + "isRequired": true, + "description": "Specifies an array of user accounts that this cmdlet enables." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name-Or-SID" + } + ], + "description": "Enables a local user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-psbreakpoint.json b/command-signatures/json/autogenerated/powershell/enable-psbreakpoint.json index 6287724a..d1dda2f3 100644 --- a/command-signatures/json/autogenerated/powershell/enable-psbreakpoint.json +++ b/command-signatures/json/autogenerated/powershell/enable-psbreakpoint.json @@ -11,6 +11,13 @@ "isRequired": true, "description": "Specifies the breakpoints to enable. Provide a variable containing breakpoints or a command that gets breakpoint objects, such as `Get-PSBreakpoint`. You can also pipe breakpoint objects to `Enable-PSBreakpoint`." }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Id", "args": [ @@ -35,14 +42,7 @@ "name": "Runspace" } ], - "description": "Specifies the Id of a Runspace object so you can interact with breakpoints in the specified runspace.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the Id of a Runspace object so you can interact with breakpoints in the specified runspace." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/enable-psremoting.json b/command-signatures/json/autogenerated/powershell/enable-psremoting.json new file mode 100644 index 00000000..10389249 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-psremoting.json @@ -0,0 +1,204 @@ +{ + "name": "Enable-PSRemoting", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "Forces the command to run without asking for user confirmation." + }, + { + "name": "-SkipNetworkProfileCheck", + "description": "Indicates that this cmdlet enables remoting on client versions of the Windows operating system when the computer is on a public network. This parameter enables a firewall rule for public networks that allows remote access only from computers in the same local subnet." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Configures the computer to receive remote commands.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-pssessionconfiguration.json b/command-signatures/json/autogenerated/powershell/enable-pssessionconfiguration.json new file mode 100644 index 00000000..819906d9 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-pssessionconfiguration.json @@ -0,0 +1,231 @@ +{ + "name": "Enable-PSSessionConfiguration", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "Indicates that the cmdlet does not prompt you for confirmation, and restarts the WinRM service without prompting. Restarting the service makes the configuration change effective." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the names of session configurations to enable. Enter one or more configuration names. Wildcard characters are permitted." + }, + { + "name": "-NoServiceRestart", + "description": "Indicates that the cmdlet does not restart the service." + }, + { + "name": "-SecurityDescriptorSddl", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a security descriptor with which this cmdlet replaces the security descriptor on the session configuration." + }, + { + "name": "-SkipNetworkProfileCheck", + "description": "Indicates that this cmdlet enables the session configuration when the computer is on a public network. This parameter enables a firewall rule for public networks that allows remote access only from computers in the same local subnet. By default, `Enable-PSSessionConfiguration` fails on a public network." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the names of session configurations to enable. Enter one or more configuration names. Wildcard characters are permitted." + } + ], + "description": "Enables the session configurations on the local computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-refsdedup.json b/command-signatures/json/autogenerated/powershell/enable-refsdedup.json new file mode 100644 index 00000000..71b194fc --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-refsdedup.json @@ -0,0 +1,229 @@ +{ + "name": "Enable-ReFSDedup", + "options": [ + { + "name": "-Type", + "args": [ + { + "name": "DedupVolumeType", + "suggestions": [ + { + "name": "Dedup" + }, + { + "name": "DedupAndCompress" + }, + { + "name": "Compress" + } + ] + } + ], + "isRequired": true + }, + { + "name": "-Volume", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + }, + { + "name": "-Type", + "suggestions": [ + { + "name": "Dedup" + }, + { + "name": "DedupAndCompress" + }, + { + "name": "Compress" + } + ] + } + ], + "description": "Enable-ReFSDedup [-Volume] [-Type] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-scheduledjob.json b/command-signatures/json/autogenerated/powershell/enable-scheduledjob.json new file mode 100644 index 00000000..1da1256e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-scheduledjob.json @@ -0,0 +1,182 @@ +{ + "name": "Enable-ScheduledJob", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Enable-ScheduledJob", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-tlsciphersuite.json b/command-signatures/json/autogenerated/powershell/enable-tlsciphersuite.json new file mode 100644 index 00000000..8f83c3c5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-tlsciphersuite.json @@ -0,0 +1,224 @@ +{ + "name": "Enable-TlsCipherSuite", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the TLS cipher suite to enable." + }, + { + "name": "-Position", + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "Specifies the position at which to insert the cipher suite in the ordered list of TLS cipher suites. The cmdlet inserts the cipher suite at the position that this parameter specifies, ahead of any existing cipher suites." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the name of the TLS cipher suite to enable." + }, + { + "name": "-Position", + "description": "Specifies the position at which to insert the cipher suite in the ordered list of TLS cipher suites. The cmdlet inserts the cipher suite at the position that this parameter specifies, ahead of any existing cipher suites." + } + ], + "description": "Enables a TLS cipher suite.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-tlsecccurve.json b/command-signatures/json/autogenerated/powershell/enable-tlsecccurve.json new file mode 100644 index 00000000..d4e61db7 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-tlsecccurve.json @@ -0,0 +1,224 @@ +{ + "name": "Enable-TlsEccCurve", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the ECC cipher suite to enable." + }, + { + "name": "-Position", + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "Specifies the position at which to insert the cipher suite in the ordered list of ECC cipher suites. The cmdlet inserts the cipher suite at the position that this parameter specifies, ahead of any existing cipher suites." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the name of the ECC cipher suite to enable." + }, + { + "name": "-Position", + "description": "Specifies the position at which to insert the cipher suite in the ordered list of ECC cipher suites. The cmdlet inserts the cipher suite at the position that this parameter specifies, ahead of any existing cipher suites." + } + ], + "description": "Enables Elliptic Curve Cryptography (ECC) cipher suites available for TLS.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-tlssessionticketkey.json b/command-signatures/json/autogenerated/powershell/enable-tlssessionticketkey.json new file mode 100644 index 00000000..a4ab5478 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-tlssessionticketkey.json @@ -0,0 +1,246 @@ +{ + "name": "Enable-TlsSessionTicketKey", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "Forces the command to run without asking for user confirmation." + }, + { + "name": "-Password", + "args": [ + { + "name": "System.Security.SecureString" + } + ], + "isRequired": true, + "description": "Specifies the password, as a secure string, for the configuration file of the TLS server." + }, + { + "name": [ + "-Path", + "-FullName" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the path of the configuration file for the TLS server." + }, + { + "name": "-ServiceAccountName", + "args": [ + { + "name": "System.Security.Principal.NTAccount" + } + ], + "isRequired": true, + "description": "Specifies the name of a service account. The cmdlet configures the TLS session ticket key for the service account. Only System, LocalService, NetworkService, and SID of virtual accounts are supported." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Password", + "description": "Specifies the password, as a secure string, for the configuration file of the TLS server." + }, + { + "name": "-Path", + "description": "Specifies the path of the configuration file for the TLS server." + }, + { + "name": "-ServiceAccountName", + "description": "Specifies the name of a service account. The cmdlet configures the TLS session ticket key for the service account. Only System, LocalService, NetworkService, and SID of virtual accounts are supported." + } + ], + "description": "Configures a TLS server with a TLS session ticket key.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-tpmautoprovisioning.json b/command-signatures/json/autogenerated/powershell/enable-tpmautoprovisioning.json new file mode 100644 index 00000000..0d042cb1 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-tpmautoprovisioning.json @@ -0,0 +1,182 @@ +{ + "name": "Enable-TpmAutoProvisioning", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Enables TPM auto-provisioning.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-windowserrorreporting.json b/command-signatures/json/autogenerated/powershell/enable-windowserrorreporting.json new file mode 100644 index 00000000..c61fbbba --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-windowserrorreporting.json @@ -0,0 +1,182 @@ +{ + "name": "Enable-WindowsErrorReporting", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Enables Windows Error Reporting.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-windowsoptionalfeature.json b/command-signatures/json/autogenerated/powershell/enable-windowsoptionalfeature.json new file mode 100644 index 00000000..0375b179 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-windowsoptionalfeature.json @@ -0,0 +1,302 @@ +{ + "name": "Enable-WindowsOptionalFeature", + "options": [ + { + "name": "-All", + "description": "Enables all parent features of the specified feature. If a parent feature is required for the specified feature to be enabled in the image, *All* will enable the parent and all of its default dependencies." + }, + { + "name": "-FeatureName", + "args": [ + { + "name": "String[]" + } + ], + "isRequired": true, + "description": "Specifies the name of the feature to be enabled. Feature names are case sensitive if you are servicing a Windows image running a version of Windows earlier than Windows® 8. You can use Get-WindowsOptionalFeature to find the name of the feature in the image." + }, + { + "name": "-LimitAccess", + "description": "Prevents DISM from contacting Windows Update when searching for the source files to restore a feature on an online image." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-NoRestart", + "description": "Suppresses reboot. If a reboot is not required, this command does nothing. This option will keep the application from prompting for a restart or keep it from restarting automatically." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-PackageName", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of a package in the Windows image." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-Source", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies the location of the files that are required to restore a feature that has been removed from the image. You can specify the Windows directory of a mounted image or a running Windows installation that is shared on the network." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Enables a feature in a Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enable-wsmancredssp.json b/command-signatures/json/autogenerated/powershell/enable-wsmancredssp.json new file mode 100644 index 00000000..afbd4ba4 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/enable-wsmancredssp.json @@ -0,0 +1,230 @@ +{ + "name": "Enable-WSManCredSSP", + "options": [ + { + "name": "-DelegateComputer", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies servers to which client credentials are delegated. The best practice is to use fully qualified domain names." + }, + { + "name": "-Force", + "description": "Forces the command to run without asking for user confirmation." + }, + { + "name": "-Role", + "args": [ + { + "name": "System.String", + "suggestions": [ + { + "name": "Client" + }, + { + "name": "Server" + } + ] + } + ], + "isRequired": true, + "description": "Specifies whether to enable CredSSP as a client or as a server. The acceptable values for this parameter are: Client and Server." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Role", + "description": "Specifies whether to enable CredSSP as a client or as a server. The acceptable values for this parameter are: Client and Server.", + "suggestions": [ + { + "name": "Client" + }, + { + "name": "Server" + } + ] + }, + { + "name": "-DelegateComputer", + "description": "Specifies servers to which client credentials are delegated. The best practice is to use fully qualified domain names." + } + ], + "description": "Enables Credential Security Support Provider (CredSSP) authentication on a computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/enter-pshostprocess.json b/command-signatures/json/autogenerated/powershell/enter-pshostprocess.json index cdaff6a7..cccc7de2 100644 --- a/command-signatures/json/autogenerated/powershell/enter-pshostprocess.json +++ b/command-signatures/json/autogenerated/powershell/enter-pshostprocess.json @@ -5,11 +5,10 @@ "name": "-AppDomainName", "args": [ { - "name": "System.String", - "default": "DefaultAppDomain" + "name": "System.String" } ], - "description": "Specifies an application domain name to connect to if omitted, uses DefaultAppDomain . Use `Get-PSHostProcessInfo` to display the application domain names." + "description": "Specifies an application domain name to connect to if omitted, uses DefaultAppDomain. Use `Get-PSHostProcessInfo` to display the application domain names." }, { "name": "-CustomPipeName", @@ -19,7 +18,7 @@ } ], "isRequired": true, - "description": "Gets or sets the custom named pipe name to connect to. This is usually used in conjunction with `pwsh -CustomPipeName`.\n" + "description": "Gets or sets the custom named pipe name to connect to. This is usually used in conjunction with `pwsh -CustomPipeName`." }, { "name": "-HostProcessInfo", @@ -240,7 +239,7 @@ }, { "name": "-AppDomainName", - "description": "Specifies an application domain name to connect to if omitted, uses DefaultAppDomain . Use `Get-PSHostProcessInfo` to display the application domain names." + "description": "Specifies an application domain name to connect to if omitted, uses DefaultAppDomain. Use `Get-PSHostProcessInfo` to display the application domain names." } ], "description": "Connects to and enters into an interactive session with a local process.", diff --git a/command-signatures/json/autogenerated/powershell/enter-pssession.json b/command-signatures/json/autogenerated/powershell/enter-pssession.json index dd9d286e..4a507a1f 100644 --- a/command-signatures/json/autogenerated/powershell/enter-pssession.json +++ b/command-signatures/json/autogenerated/powershell/enter-pssession.json @@ -3,7 +3,7 @@ "options": [ { "name": "-AllowRedirection", - "description": "Allows redirection of this connection to an alternate Uniform Resource Identifier (URI). By default, redirection is not allowed.\n" + "description": "Allows redirection of this connection to an alternate Uniform Resource Identifier (URI). By default, redirection isn't allowed." }, { "name": "-ApplicationName", @@ -12,7 +12,7 @@ "name": "System.String" } ], - "description": "Specifies the application name segment of the connection URI. Use this parameter to specify the application name when you are not using the ConnectionURI parameter in the command.\n" + "description": "Specifies the application name segment of the connection URI. Use this parameter to specify the application name when you aren't using the ConnectionURI parameter in the command." }, { "name": "-Authentication", @@ -21,30 +21,30 @@ "name": "System.Management.Automation.Runspaces.AuthenticationMechanism", "suggestions": [ { - "name": "Default" + "name": "Basic" }, { - "name": "Basic" + "name": "Credssp" }, { - "name": "Negotiate" + "name": "Default" }, { - "name": "NegotiateWithImplicitCredential" + "name": "Digest" }, { - "name": "Credssp" + "name": "Kerberos" }, { - "name": "Digest" + "name": "Negotiate" }, { - "name": "Kerberos" + "name": "NegotiateWithImplicitCredential" } ] } ], - "description": "Specifies the mechanism that is used to authenticate the user's credentials. The acceptable values for this parameter are:\n" + "description": "Specifies the mechanism that's used to authenticate the user's credentials. The acceptable values for this parameter are:" }, { "name": "-CertificateThumbprint", @@ -53,7 +53,7 @@ "name": "System.String" } ], - "description": "Specifies the digital public key certificate (X509) of a user account that has permission to perform this action. Enter the certificate thumbprint of the certificate.\n" + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to perform this action. Enter the certificate thumbprint of the certificate." }, { "name": [ @@ -66,7 +66,7 @@ } ], "isRequired": true, - "description": "Specifies a computer name. This cmdlet starts an interactive session with the specified remote computer. Enter only one computer name. The default is the local computer.\n" + "description": "Specifies a computer name. This cmdlet starts an interactive session with the specified remote computer. Enter only one computer name. The default is the local computer." }, { "name": "-ConfigurationName", @@ -75,17 +75,16 @@ "name": "System.String" } ], - "description": "Specifies the session configuration that is used for the interactive session.\n" + "description": "Specifies the session configuration that's used for the interactive session." }, { "name": "-ConnectingTimeout", "args": [ { - "name": "System.Int32", - "default": "unlimited" + "name": "System.Int32" } ], - "description": "Specifies the amount of time in milliseconds allowed for the initial SSH connection to complete. If the connection doesn't complete within the specified time, an error is returned.\n" + "description": "Specifies the amount of time in milliseconds allowed for the initial SSH connection to complete. If the connection doesn't complete within the specified time, an error is returned." }, { "name": [ @@ -98,7 +97,7 @@ "name": "System.Uri" } ], - "description": "Specifies a URI that defines the connection endpoint for the session. The URI must be fully qualified. The format of this string is as follows:\n" + "description": "Specifies a URI that defines the connection endpoint for the session. The URI must be fully qualified. The format of this string is as follows:" }, { "name": "-ContainerId", @@ -114,15 +113,15 @@ "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to perform this action. The default is the current user.\n" + "isRequired": true, + "description": "Specifies a user account that has permission to perform this action. The default is the current user." }, { "name": "-EnableNetworkAccess", - "description": "Indicates that this cmdlet adds an interactive security token to loopback sessions. The interactive token lets you run commands in the loopback session that get data from other computers. For example, you can run a command in the session that copies XML files from a remote computer to the local computer.\n" + "description": "Indicates that this cmdlet adds an interactive security token to loopback sessions. The interactive token lets you run commands in the loopback session that get data from other computers. For example, you can run a command in the session that copies XML files from a remote computer to the local computer." }, { "name": "-HostName", @@ -132,7 +131,7 @@ } ], "isRequired": true, - "description": "Specifies a computer name for a Secure Shell (SSH) based connection. This is similar to the ComputerName parameter except that the connection to the remote computer is made using SSH rather than Windows WinRM. This parameter supports specifying the user name and/or port as part of the host name parameter value using the form `user@hostname:port`. The user name and/or port specified as part of the host name takes precedence over the `-UserName` and `-Port` parameters, if specified. This allows passing multiple computer names to this parameter where some have specific user names and/or ports, while others use the user name and/or port from the `-UserName` and `-Port` parameters.\n" + "description": "Specifies a computer name for a Secure Shell (SSH) based connection. This is similar to the ComputerName parameter except that the connection to the remote computer is made using SSH rather than Windows WinRM. This parameter supports specifying the user name and/or port as part of the HostName parameter value using the form `user@hostname:port`. The user name and/or port specified as part of the host name takes precedence over the `-UserName` and `-Port` parameters, if specified. This allows passing multiple computer names to this parameter where some have specific user names and/or ports, while others use the user name and/or port from the `-UserName` and `-Port` parameters." }, { "name": "-Id", @@ -141,7 +140,7 @@ "name": "System.Int32" } ], - "description": "Specifies the ID of an existing session. `Enter-PSSession` uses the specified session for the interactive session.\n" + "description": "Specifies the ID of an existing session. `Enter-PSSession` uses the specified session for the interactive session." }, { "name": "-InstanceId", @@ -150,7 +149,7 @@ "name": "System.Guid" } ], - "description": "Specifies the instance ID of an existing session. `Enter-PSSession` uses the specified session for the interactive session.\n" + "description": "Specifies the instance ID of an existing session. `Enter-PSSession` uses the specified session for the interactive session." }, { "name": [ @@ -162,7 +161,7 @@ "name": "System.String" } ], - "description": "Specifies a key file path used by Secure Shell (SSH) to authenticate a user on a remote computer.\n" + "description": "Specifies a key file path used by Secure Shell (SSH) to authenticate a user on a remote computer." }, { "name": "-Name", @@ -171,7 +170,7 @@ "name": "System.String" } ], - "description": "Specifies the friendly name of an existing session. `Enter-PSSession` uses the specified session for the interactive session.\n" + "description": "Specifies the friendly name of an existing session. `Enter-PSSession` uses the specified session for the interactive session." }, { "name": "-Options", @@ -180,7 +179,7 @@ "name": "System.Collections.Hashtable" } ], - "description": "Specifies a hashtable of SSH options used when connecting to a remote SSH-based session. The possible options are any values supported by the Unix-based version of the ssh (https://man.openbsd.org/ssh#o)command.\n" + "description": "Specifies a hashtable of SSH options used when connecting to a remote SSH-based session. The possible options are any values supported by the Unix-based version of the [ssh](https://man.openbsd.org/ssh#o) command." }, { "name": "-Port", @@ -189,7 +188,7 @@ "name": "System.Int32" } ], - "description": "Specifies the network port on the remote computer that is used for this command.\n" + "description": "Specifies the network port on the remote computer that's used for this command." }, { "name": "-RunAsAdministrator", @@ -202,7 +201,7 @@ "name": "System.Management.Automation.Runspaces.PSSession" } ], - "description": "Specifies a PowerShell session ( PSSession ) to use for the interactive session. This parameter takes a session object. You can also use the Name , InstanceID , or ID parameters to specify a PSSession .\n" + "description": "Specifies a PowerShell session (PSSession) to use for the interactive session. This parameter takes a session object. You can also use the Name, InstanceId, or Id parameters to specify a PSSession." }, { "name": "-SessionOption", @@ -211,21 +210,20 @@ "name": "System.Management.Automation.Remoting.PSSessionOption" } ], - "description": "Sets advanced options for the session. Enter a SessionOption object, such as one that you create by using the `New-PSSessionOption` cmdlet, or a hash table in which the keys are session option names and the values are session option values.\n" + "description": "Sets advanced options for the session. Enter a SessionOption object, such as one that you create by using the `New-PSSessionOption` cmdlet, or a hash table in which the keys are session option names and the values are session option values." }, { "name": "-SSHTransport", - "description": "Indicates that the remote connection is established using Secure Shell (SSH).\n" + "description": "Indicates that the remote connection is established using Secure Shell (SSH)." }, { "name": "-Subsystem", "args": [ { - "name": "System.String", - "default": "Powershell" + "name": "System.String" } ], - "description": "Specifies the SSH subsystem used for the new PSSession .\n" + "description": "Specifies the SSH subsystem used for the new PSSession." }, { "name": "-UserName", @@ -234,11 +232,11 @@ "name": "System.String" } ], - "description": "Specifies the user name for the account used to create a session on the remote computer. User authentication method will depend on how Secure Shell (SSH) is configured on the remote computer.\n" + "description": "Specifies the user name for the account used to create a session on the remote computer. If the UserName parameter isn't specified then the current logged on username is used. User authentication method depends on how Secure Shell (SSH) is configured on the remote computer." }, { "name": "-UseSSL", - "description": "Indicates that this cmdlet uses the Secure Sockets Layer (SSL) protocol to establish a connection to the remote computer. By default, SSL is not used.\n" + "description": "Indicates that this cmdlet uses the Secure Sockets Layer (SSL) protocol to establish a connection to the remote computer. By default, SSL isn't used." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/expand-osimage.json b/command-signatures/json/autogenerated/powershell/expand-osimage.json new file mode 100644 index 00000000..64a058db --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/expand-osimage.json @@ -0,0 +1,244 @@ +{ + "name": "Expand-OsImage", + "options": [ + { + "name": "-ApplyPath", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-ImagePath", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + }, + { + "name": "Debug" + } + ] + } + ] + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Expand-OsImage -ImagePath -ApplyPath [-LogPath ] [-ScratchDirectory ] [-LogLevel ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/expand-windowscustomdataimage.json b/command-signatures/json/autogenerated/powershell/expand-windowscustomdataimage.json new file mode 100644 index 00000000..606a71f2 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/expand-windowscustomdataimage.json @@ -0,0 +1,254 @@ +{ + "name": "Expand-WindowsCustomDataImage", + "options": [ + { + "name": "-CustomDataImage", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the custom data of a Windows image captured in a WIM container." + }, + { + "name": "-ImagePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location of a WIM file." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SingleInstance", + "isRequired": true, + "description": "Indicates that this cmdlet changes the custom data files applied on the operating system partition to file pointers backed up by the file payloads in the custom data image." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Expands a custom data image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/expand-windowsimage.json b/command-signatures/json/autogenerated/powershell/expand-windowsimage.json new file mode 100644 index 00000000..dc8661e4 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/expand-windowsimage.json @@ -0,0 +1,306 @@ +{ + "name": "Expand-WindowsImage", + "options": [ + { + "name": "-ApplyPath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location where the image is to be applied." + }, + { + "name": "-CheckIntegrity", + "description": "Detects and tracks .wim file corruption when used with the Add-WindowsImage, Dismount-WindowsImage, or Save-WindowsImage cmdlet. CheckIntegrity stops the operation if DISM detects that the .wim file is corrupted when used with the Expand-WindowsImage or Mount-WindowsImage cmdlet." + }, + { + "name": "-Compact", + "description": "Indicates that this cmdlet applies the operating system image to the specified drive with individual operating system files compressed. If you do not specify this parameter, this cmdlet lays down all of the files in the image without compression." + }, + { + "name": "-ConfirmTrustedFile", + "description": "Specifies that this cmdlet validates the image for Trusted Desktop on Windows 8 or Windows 8.1. This option can only be run on a computer running at least Windows Preinstallation Environment (Windows PE) 4.0." + }, + { + "name": "-ImagePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location of a WIM file." + }, + { + "name": "-Index", + "args": [ + { + "name": "UInt32" + } + ], + "isRequired": true, + "description": "Specifies the index number of a Windows image in a WIM or VHD file. For a VHD file, the Index must be 1." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Name", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the name of an image in a WIM file." + }, + { + "name": "-NoRpFix", + "description": "Disables the reparse point tag fix. A reparse point is a file that contains a link to another file on the file system. If the parameter is not specified, reparse points that resolve to paths outside of the value specified by the *ImagePath* parameter will not be captured." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SplitImageFilePattern", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location and name of the base split image file." + }, + { + "name": "-SupportEa", + "description": "Applies an image with extended attributes." + }, + { + "name": "-Verify", + "description": "Checks for errors and file duplication. During an apply operation, for example, using the Add-WindowsImage cmdlet, the size and the hash of the file being applied are checked against the image file to verify they are both equal. During a capture operation, for example, when using the New-WindowsImage cmdlet, after the files is captured into a Windows image, the file is written to a temporary file and compared on a bit-by-bit basis with the original file." + }, + { + "name": "-WIMBoot", + "description": "Specifies that the offline image to be added will be formatted to install on a Windows Image Format Boot (WIMBoot) system." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Applies an image to a specified location.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/export-alias.json b/command-signatures/json/autogenerated/powershell/export-alias.json index 252664f1..10c0d1f6 100644 --- a/command-signatures/json/autogenerated/powershell/export-alias.json +++ b/command-signatures/json/autogenerated/powershell/export-alias.json @@ -20,7 +20,14 @@ ] } ], - "description": "Specifies the output format. CSV is the default. The acceptable values for this parameter are:\n" + "description": "Specifies the output format. CSV is the default. The acceptable values for this parameter are:" + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-Description", @@ -33,7 +40,7 @@ }, { "name": "-Force", - "description": "Forces the command to run without asking for user confirmation.\n" + "description": "Forces the command to run without asking for user confirmation." }, { "name": [ @@ -47,7 +54,7 @@ } ], "isRequired": true, - "description": "Specifies the path to the output file. Unlike Path , the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + "description": "Specifies the path to the output file. Unlike Path, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Name", @@ -56,14 +63,14 @@ "name": "System.String[]" } ], - "description": "Specifies the names as an array of the aliases to export. Wildcards are permitted.\n" + "description": "Specifies the names as an array of the aliases to export. Wildcards are permitted." }, { "name": [ "-NoClobber", "-NoOverwrite" ], - "description": "Indicates that this cmdlet prevents `Export-Alias` from overwriting any files, even if the Force parameter is used in the command.\n" + "description": "Indicates that this cmdlet prevents `Export-Alias` from overwriting any files, even if the Force parameter is used in the command." }, { "name": "-PassThru", @@ -86,14 +93,7 @@ "name": "System.String" } ], - "description": "Specifies the scope from which the aliases should be exported. The acceptable values for this parameter are:\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the scope from which the aliases should be exported. The acceptable values for this parameter are:" }, { "name": [ @@ -280,7 +280,7 @@ }, { "name": "-Name", - "description": "Specifies the names as an array of the aliases to export. Wildcards are permitted.\n" + "description": "Specifies the names as an array of the aliases to export. Wildcards are permitted." } ], "description": "Exports information about currently defined aliases to a file.", diff --git a/command-signatures/json/autogenerated/powershell/export-bcdstore.json b/command-signatures/json/autogenerated/powershell/export-bcdstore.json new file mode 100644 index 00000000..af1445a4 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/export-bcdstore.json @@ -0,0 +1,215 @@ +{ + "name": "Export-BcdStore", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": "-Path", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Path Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path", + "description": "{{ Fill Path Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/export-certificate.json b/command-signatures/json/autogenerated/powershell/export-certificate.json new file mode 100644 index 00000000..f127b28e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/export-certificate.json @@ -0,0 +1,247 @@ +{ + "name": "Export-Certificate", + "options": [ + { + "name": "-Cert", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.Certificate" + } + ], + "isRequired": true, + "description": "Specifies one or more certificates to be exported to a file. A single certificate object, an array of certificate objects, or a path to one or more certificates in a certificate store can be specified." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-FilePath", + "-FullName" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the location where the exported certificate will be stored." + }, + { + "name": "-Force", + "description": "Specifies that the exported certificate file will overwrite an existing certificate file, even if it has the Read-only attribute set. The NoClobber parameter takes precedence over this parameter when both are used." + }, + { + "name": "-NoClobber", + "description": "Prevents an exported certificate file from overwriting an existing certificate file. This parameter takes precedence over the Force parameter, which permits this cmdlet to overwrite an existing certificate file, even if it has the Read-only attribute set." + }, + { + "name": "-Type", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.CertType", + "suggestions": [ + { + "name": "SST" + }, + { + "name": "CERT" + }, + { + "name": "P7B" + } + ] + } + ], + "description": "Specifies the type of output file for the certificate export as follows." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Exports a certificate from a certificate store into a file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/export-clixml.json b/command-signatures/json/autogenerated/powershell/export-clixml.json index 65f873c9..7c49f9ff 100644 --- a/command-signatures/json/autogenerated/powershell/export-clixml.json +++ b/command-signatures/json/autogenerated/powershell/export-clixml.json @@ -1,15 +1,21 @@ { "name": "Export-Clixml", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Depth", "args": [ { - "name": "System.Int32", - "default": "2" + "name": "System.Int32" } ], - "description": "Specifies how many levels of contained objects are included in the XML representation. The default value is `2`.\n" + "description": "Specifies how many levels of contained objects are included in the XML representation. The default value is `2`." }, { "name": "-Encoding", @@ -18,44 +24,46 @@ "name": "System.Text.Encoding", "suggestions": [ { - "name": "ASCII" + "name": "ansi" + }, + { + "name": "ascii" }, { - "name": "BigEndianUnicode" + "name": "bigendianunicode" }, { - "name": "BigEndianUTF32" + "name": "bigendianutf32" }, { - "name": "OEM" + "name": "oem" }, { - "name": "Unicode" + "name": "unicode" }, { - "name": "UTF7" + "name": "utf32" }, { - "name": "UTF8" + "name": "utf7" }, { - "name": "UTF8BOM" + "name": "utf8" }, { - "name": "UTF8NoBOM" + "name": "utf8BOM" }, { - "name": "UTF32" + "name": "utf8NoBOM" } - ], - "default": "UTF8NoBOM" + ] } ], - "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`.\n" + "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`." }, { "name": "-Force", - "description": "Forces the command to run without asking for user confirmation.\n" + "description": "Forces the command to run without asking for user confirmation." }, { "name": "-InputObject", @@ -79,7 +87,7 @@ } ], "isRequired": true, - "description": "Specifies the path to the file where the XML representation of the object will be stored. Unlike Path , the value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + "description": "Specifies the path to the file where the XML representation of the object will be stored. Unlike Path, the value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": [ @@ -98,13 +106,6 @@ "isRequired": true, "description": "Specifies the path to the file where the XML representation of the object will be stored." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/export-counter.json b/command-signatures/json/autogenerated/powershell/export-counter.json new file mode 100644 index 00000000..0704cd2d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/export-counter.json @@ -0,0 +1,229 @@ +{ + "name": "Export-Counter", + "options": [ + { + "name": "-Circular" + }, + { + "name": "-FileFormat", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Force" + }, + { + "name": "-InputObject", + "args": [ + { + "name": "PerformanceCounterSampleSet[]" + } + ], + "isRequired": true + }, + { + "name": "-MaxSize", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": [ + "-Path", + "-PSPath" + ], + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path" + } + ], + "description": "Export-Counter [-Path] -InputObject [-FileFormat ] [-MaxSize ] [-Force] [-Circular] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/export-csv.json b/command-signatures/json/autogenerated/powershell/export-csv.json index 94630849..e6a85257 100644 --- a/command-signatures/json/autogenerated/powershell/export-csv.json +++ b/command-signatures/json/autogenerated/powershell/export-csv.json @@ -3,17 +3,23 @@ "options": [ { "name": "-Append", - "description": "Use this parameter so that `Export-CSV` adds CSV output to the end of the specified file. Without this parameter, `Export-CSV` replaces the file contents without warning.\n" + "description": "Use this parameter so that `Export-Csv` adds CSV output to the end of the specified file. Without this parameter, `Export-Csv` replaces the file contents without warning." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-Delimiter", "args": [ { - "name": "System.Char", - "default": "comma (,)" + "name": "System.Char" } ], - "description": "Specifies a delimiter to separate the property values. The default is a comma (`,`). Enter a character, such as a colon (`:`). To specify a semicolon (`;`), enclose it in quotation marks." + "description": "Specifies a delimiter to separate the property values. The default is a comma (`,`)." }, { "name": "-Encoding", @@ -22,51 +28,53 @@ "name": "System.Text.Encoding", "suggestions": [ { - "name": "ASCII" + "name": "ansi" }, { - "name": "BigEndianUnicode" + "name": "ascii" }, { - "name": "BigEndianUTF32" + "name": "bigendianunicode" }, { - "name": "OEM" + "name": "bigendianutf32" }, { - "name": "Unicode" + "name": "oem" }, { - "name": "UTF7" + "name": "unicode" }, { - "name": "UTF8" + "name": "utf32" }, { - "name": "UTF8BOM" + "name": "utf7" }, { - "name": "UTF8NoBOM" + "name": "utf8" }, { - "name": "UTF32" + "name": "utf8BOM" + }, + { + "name": "utf8NoBOM" } - ], - "default": "UTF8NoBOM" + ] } ], - "description": "Specifies the encoding for the exported CSV file. The default value is `utf8NoBOM`.\n" + "description": "Specifies the encoding for the exported CSV file. The default value is `utf8NoBOM`." }, { "name": "-Force", - "description": "This parameter allows `Export-Csv` to overwrite files with the Read Only attribute.\n" + "description": "This parameter allows `Export-Csv` to overwrite files with the Read Only attribute." }, { "name": [ "-IncludeTypeInformation", "-ITI" ], - "description": "When this parameter is used the first line of the CSV output contains `#TYPE` followed by the fully qualified name of the object type. For example, `#TYPE System.Diagnostics.Process`.\n" + "description": "When this parameter is used the first line of the CSV output contains `#TYPE` followed by the fully qualified name of the object type. For example, `#TYPE System.Diagnostics.Process`." }, { "name": "-InputObject", @@ -76,7 +84,7 @@ } ], "isRequired": true, - "description": "Specifies the objects to export as CSV strings. Enter a variable that contains the objects or type a command or expression that gets the objects. You can also pipe objects to `Export-CSV`." + "description": "Specifies the objects to export as CSV strings. Enter a variable that contains the objects or type a command or expression that gets the objects. You can also pipe objects to `Export-Csv`." }, { "name": [ @@ -89,14 +97,18 @@ "name": "System.String" } ], - "description": "Specifies the path to the CSV output file. Unlike Path , the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, use single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + "description": "Specifies the path to the CSV output file. Unlike Path, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, use single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": [ "-NoClobber", "-NoOverwrite" ], - "description": "Use this parameter so that `Export-CSV` does not overwrite an existing file. By default, if the file exists in the specified path, `Export-CSV` overwrites the file without warning." + "description": "Use this parameter so that `Export-Csv` does not overwrite an existing file. By default, if the file exists in the specified path, `Export-Csv` overwrites the file without warning." + }, + { + "name": "-NoHeader", + "description": "When this parameter is used, the cmdlet doesn't write a header row containing the column names to the output." }, { "name": [ @@ -138,17 +150,20 @@ "args": [ { "name": "Microsoft.PowerShell.Commands.BaseCsvWritingCommand+QuoteKind", - "default": "Always" + "suggestions": [ + { + "name": "Always" + }, + { + "name": "AsNeeded" + }, + { + "name": "Never" + } + ] } ], - "description": "Specifies when quotes are used in the CSV files. Possible values are:\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies when quotes are used in the CSV files. Possible values are:" }, { "name": [ @@ -335,7 +350,7 @@ }, { "name": "-Delimiter", - "description": "Specifies a delimiter to separate the property values. The default is a comma (`,`). Enter a character, such as a colon (`:`). To specify a semicolon (`;`), enclose it in quotation marks." + "description": "Specifies a delimiter to separate the property values. The default is a comma (`,`)." } ], "description": "Converts objects into a series of character-separated value (CSV) strings and saves the strings to a file.", diff --git a/command-signatures/json/autogenerated/powershell/export-formatdata.json b/command-signatures/json/autogenerated/powershell/export-formatdata.json index e83ea376..c68286b0 100644 --- a/command-signatures/json/autogenerated/powershell/export-formatdata.json +++ b/command-signatures/json/autogenerated/powershell/export-formatdata.json @@ -7,7 +7,7 @@ }, { "name": "-IncludeScriptBlock", - "description": "Indicates whether script blocks in the format data are exported.\n" + "description": "Indicates whether scriptblocks in the format data are exported." }, { "name": "-InputObject", @@ -38,7 +38,7 @@ "-NoClobber", "-NoOverwrite" ], - "description": "Indicates that the cmdlet does not overwrite existing files. By default, `Export-FormatData` overwrites files without warning unless the file has the read-only attribute.\n" + "description": "Indicates that the cmdlet does not overwrite existing files. By default, `Export-FormatData` overwrites files without warning unless the file has the read-only attribute." }, { "name": [ @@ -51,7 +51,7 @@ } ], "isRequired": true, - "description": "Specifies a location for the output file. Enter a path (optional) and file name with a format.ps1xml file name extension. If you omit the path, `Export-FormatData` creates the file in the current directory.\n" + "description": "Specifies a location for the output file. Enter a path (optional) and file name with a `format.ps1xml` file name extension. If you omit the path, `Export-FormatData` creates the file in the current directory." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/export-modulemember.json b/command-signatures/json/autogenerated/powershell/export-modulemember.json index 88a326aa..496de79f 100644 --- a/command-signatures/json/autogenerated/powershell/export-modulemember.json +++ b/command-signatures/json/autogenerated/powershell/export-modulemember.json @@ -17,7 +17,7 @@ "name": "System.String[]" } ], - "description": "Specifies the cmdlets that are exported from the script module file. Enter the cmdlet names. Wildcard characters are permitted.\n" + "description": "Specifies the cmdlets that are exported from the script module file. Enter the cmdlet names. Wildcard characters are permitted." }, { "name": "-Function", diff --git a/command-signatures/json/autogenerated/powershell/export-osimage.json b/command-signatures/json/autogenerated/powershell/export-osimage.json new file mode 100644 index 00000000..f733e603 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/export-osimage.json @@ -0,0 +1,244 @@ +{ + "name": "Export-OsImage", + "options": [ + { + "name": "-DestImagePath", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + }, + { + "name": "Debug" + } + ] + } + ] + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-SrcImagePath", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Export-OsImage -SrcImagePath -DestImagePath [-LogPath ] [-ScratchDirectory ] [-LogLevel ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/export-pfxcertificate.json b/command-signatures/json/autogenerated/powershell/export-pfxcertificate.json new file mode 100644 index 00000000..96adfa74 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/export-pfxcertificate.json @@ -0,0 +1,325 @@ +{ + "name": "Export-PfxCertificate", + "options": [ + { + "name": [ + "-Cert", + "-PsPath" + ], + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.Certificate" + } + ], + "isRequired": true, + "description": "Specifies the path to the certificate to be exported." + }, + { + "name": "-ChainOption", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.ExportChainOption", + "suggestions": [ + { + "name": "BuildChain" + }, + { + "name": "EndEntityCertOnly" + }, + { + "name": "PfxDataOnly" + } + ] + } + ], + "description": "Specifies the options for building a chain when exporting certificates. The acceptable values for this parameter are:" + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-CryptoAlgorithmOption", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions", + "suggestions": [ + { + "name": "TripleDES_SHA1" + }, + { + "name": "AES256_SHA256" + } + ] + } + ], + "description": "Specifies the algorithm for encrypting private keys within the PFX file. If this parameter is not specified, the default is `TripleDES_SHA1`. The acceptable values for this parameter are:" + }, + { + "name": "-FilePath", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the path for the PFX file to be exported." + }, + { + "name": "-Force", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions" + } + ], + "description": "Specifies that the provided PFX file should be overwritten, even if the Read-only attribute is set on the file. By default, this cmdlet overwrites existing PFX files without warning, unless the Read-only or hidden attribute is set or the NoClobber parameter is used in the cmdlet." + }, + { + "name": "-NoClobber", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions" + } + ], + "description": "Specifies that if the PFX file already exists, it should not be overwritten. This parameter takes precedence over the Force parameter, which permits this cmdlet to overwrite a PFX file even if it has the Read-only attribute set." + }, + { + "name": "-NoProperties", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions" + } + ], + "description": "Specifies whether the extended properties for a certificate are exported. If this parameter is specified, then extended properties are not included with the export. By default, all extended properties are included in the exported file." + }, + { + "name": "-PFXData", + "args": [ + { + "name": "PfxData" + } + ], + "isRequired": true, + "description": "Specifies a PFXData object that contains one or more certificates from a PFX file." + }, + { + "name": "-Password", + "args": [ + { + "name": "System.SecureString" + } + ], + "description": "Specifies the password used to protect the exported PFX file. The password should be in the form of secure string. Either the ProtectTo or this parameter must be specified, or an error will be displayed." + }, + { + "name": "-ProtectTo", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies an array of strings for the username or group name that can access the private key of PFX file without any password. This requires a Windows Server 2012 or later domain controller. Either the Password or this parameter must be specified, or an error will be displayed." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions", + "default": "False" + } + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Cert-Or-PFXData" + }, + { + "name": "-FilePath", + "description": "Specifies the path for the PFX file to be exported." + } + ], + "description": "Exports a certificate or a PFXData object to a Personal Information Exchange (PFX) file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/export-provisioningpackage.json b/command-signatures/json/autogenerated/powershell/export-provisioningpackage.json new file mode 100644 index 00000000..2e568853 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/export-provisioningpackage.json @@ -0,0 +1,282 @@ +{ + "name": "Export-ProvisioningPackage", + "options": [ + { + "name": [ + "-AllowClobber", + "-Force", + "-Overwrite" + ], + "description": "Indicates that the cmdlet exports contents even if there's an existing instance." + }, + { + "name": "-AnswerFileOnly", + "description": "Indicates that the cmdlet only exports the Windows provisioning answer file." + }, + { + "name": [ + "-ConnectedDevice", + "-Device" + ], + "description": "Indicates that the provisioning package uses a connected device." + }, + { + "name": [ + "-LogsDirectoryPath", + "-Logs" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a path to store logs files resulting from the export operation." + }, + { + "name": [ + "-OutputFolder", + "-Out" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the path to the output directory." + }, + { + "name": [ + "-PackageId", + "-Id" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the ID of the Package to be extracted." + }, + { + "name": [ + "-PackagePath", + "-Path" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the path to the package to be extracted." + }, + { + "name": "-RuntimeMetadata", + "args": [ + { + "name": "RuntimeProvPackageMetadata" + } + ], + "isRequired": true, + "description": "Specifies a runtime provisioning package metadata object." + }, + { + "name": [ + "-WprpFile", + "-Wprp" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of a WPR profile file." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-PackagePath-Or-RuntimeMetadata" + }, + { + "name": "-OutputFolder", + "description": "Specifies the path to the output directory." + } + ], + "description": "Extract the contents of a provisioning package.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/export-pssession.json b/command-signatures/json/autogenerated/powershell/export-pssession.json index 5bf141aa..825c8bbe 100644 --- a/command-signatures/json/autogenerated/powershell/export-pssession.json +++ b/command-signatures/json/autogenerated/powershell/export-pssession.json @@ -3,7 +3,7 @@ "options": [ { "name": "-AllowClobber", - "description": "Exports the specified commands, even if they have the same names as commands in the current session.\n" + "description": "Exports the specified commands, even if they have the same names as commands in the current session." }, { "name": [ @@ -15,7 +15,7 @@ "name": "System.Object[]" } ], - "description": "Exports the variant of the command that results from using the specified arguments (parameter values).\n" + "description": "Exports the variant of the command that results from using the specified arguments (parameter values)." }, { "name": "-Certificate", @@ -24,7 +24,7 @@ "name": "System.Security.Cryptography.X509Certificates.X509Certificate2" } ], - "description": "Specifies the client certificate that is used to sign the format files (*.Format.ps1xml) or script module files (.psm1) in the module that `Export-PSSession` creates. Enter a variable that contains a certificate or a command or expression that gets the certificate.\n" + "description": "Specifies the client certificate that is used to sign the format files (*.Format.ps1xml) or script module files (`.psm1`) in the module that `Export-PSSession` creates. Enter a variable that contains a certificate or a command or expression that gets the certificate." }, { "name": [ @@ -33,11 +33,10 @@ ], "args": [ { - "name": "System.String[]", - "default": "All commands in the session." + "name": "System.String[]" } ], - "description": "Exports only the commands with the specified names or name patterns. Wildcards are permitted. Use CommandName or its alias, Name .\n" + "description": "Exports only the commands with the specified names or name patterns. Wildcards are permitted. Use CommandName or its alias, Name." }, { "name": [ @@ -74,15 +73,11 @@ }, { "name": "Script" - }, - { - "name": "Workflow" } - ], - "default": "All commands in the session." + ] } ], - "description": "Exports only the specified types of command objects. Use CommandType or its alias, Type .\n" + "description": "Exports only the specified types of command objects. Use CommandType or its alias, Type." }, { "name": "-Encoding", @@ -91,40 +86,42 @@ "name": "System.Text.Encoding", "suggestions": [ { - "name": "ASCII" + "name": "ansi" }, { - "name": "BigEndianUnicode" + "name": "ascii" }, { - "name": "BigEndianUTF32" + "name": "bigendianunicode" }, { - "name": "OEM" + "name": "bigendianutf32" }, { - "name": "Unicode" + "name": "oem" }, { - "name": "UTF7" + "name": "unicode" }, { - "name": "UTF8" + "name": "utf32" }, { - "name": "UTF8BOM" + "name": "utf7" }, { - "name": "UTF8NoBOM" + "name": "utf8" }, { - "name": "UTF32" + "name": "utf8BOM" + }, + { + "name": "utf8NoBOM" } - ], - "default": "UTF8NoBOM" + ] } ], - "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`.\n" + "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`." }, { "name": "-Force", @@ -137,7 +134,7 @@ "name": "System.String[]" } ], - "description": "Exports formatting instructions only for the specified Microsoft .NET Framework types. Enter the type names. By default, `Export-PSSession` exports formatting instructions for all .NET Framework types that are not in the System.Management.Automation namespace.\n" + "description": "Exports formatting instructions only for the specified Microsoft .NET Framework types. Enter the type names. By default, `Export-PSSession` exports formatting instructions for all .NET Framework types that are not in the System.Management.Automation namespace." }, { "name": "-FullyQualifiedModule", @@ -146,7 +143,7 @@ "name": "Microsoft.PowerShell.Commands.ModuleSpecification[]" } ], - "description": "The value can be a module name, a full module specification, or a path to a module file.\n" + "description": "The value can be a module name, a full module specification, or a path to a module file." }, { "name": [ @@ -155,11 +152,10 @@ ], "args": [ { - "name": "System.String[]", - "default": "All commands in the session." + "name": "System.String[]" } ], - "description": "Exports only the commands in the specified PowerShell snap-ins and modules. Enter the snap-in and module names. Wildcards are not permitted.\n" + "description": "Exports only the commands in the specified PowerShell snap-ins and modules. Enter the snap-in and module names. Wildcards are not permitted." }, { "name": [ @@ -169,12 +165,11 @@ ], "args": [ { - "name": "System.String", - "default": "$HOME\\Documents\\WindowsPowerShell\\Modules" + "name": "System.String" } ], "isRequired": true, - "description": "Specifies an optional path and name for the module created by `Export-PSSession`. The default path is `$HOME\\Documents\\WindowsPowerShell\\Modules`. This parameter is required.\n" + "description": "Specifies an optional path and name for the module created by `Export-PSSession`. The default path is `$HOME\\Documents\\WindowsPowerShell\\Modules`. This parameter is required." }, { "name": "-Session", @@ -364,15 +359,15 @@ }, { "name": "-OutputModule", - "description": "Specifies an optional path and name for the module created by `Export-PSSession`. The default path is `$HOME\\Documents\\WindowsPowerShell\\Modules`. This parameter is required.\n" + "description": "Specifies an optional path and name for the module created by `Export-PSSession`. The default path is `$HOME\\Documents\\WindowsPowerShell\\Modules`. This parameter is required." }, { "name": "-CommandName", - "description": "Exports only the commands with the specified names or name patterns. Wildcards are permitted. Use CommandName or its alias, Name .\n" + "description": "Exports only the commands with the specified names or name patterns. Wildcards are permitted. Use CommandName or its alias, Name." }, { "name": "-FormatTypeName", - "description": "Exports formatting instructions only for the specified Microsoft .NET Framework types. Enter the type names. By default, `Export-PSSession` exports formatting instructions for all .NET Framework types that are not in the System.Management.Automation namespace.\n" + "description": "Exports formatting instructions only for the specified Microsoft .NET Framework types. Enter the type names. By default, `Export-PSSession` exports formatting instructions for all .NET Framework types that are not in the System.Management.Automation namespace." } ], "description": "Exports commands from another session and saves them in a PowerShell module.", diff --git a/command-signatures/json/autogenerated/powershell/export-startlayout.json b/command-signatures/json/autogenerated/powershell/export-startlayout.json new file mode 100644 index 00000000..74177079 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/export-startlayout.json @@ -0,0 +1,225 @@ +{ + "name": "Export-StartLayout", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-LiteralPath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a literal path to a layout file. Include the file .xml file name extension. This parameter does not accept the wildcard character (*). If the path includes an escape character (\\\\), enclose the string in single quotes (')." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies an absolute path to a layout file." + }, + { + "name": "-UseDesktopApplicationID", + "description": "Specifies that the layout file should export the DesktopApplicationID value instead of DesktopApplicationLinkPath which is the default. DesktopApplicationID is the application's ID and DesktopApplicationLinkPath is a path to a shortcut link (.lnk file) to a Windows desktop application." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path", + "description": "Specifies an absolute path to a layout file." + } + ], + "description": "Exports the layout of the Start screen.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/export-startlayoutedgeassets.json b/command-signatures/json/autogenerated/powershell/export-startlayoutedgeassets.json new file mode 100644 index 00000000..2bd2c610 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/export-startlayoutedgeassets.json @@ -0,0 +1,221 @@ +{ + "name": "Export-StartLayoutEdgeAssets", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-LiteralPath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a literal path for an asset file. Include the `.xml` file name extension. This parameter does not accept the wildcard character (*). If the path includes an escape character (\\\\), enclose the string in single quotes (')." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies an absolute path for an asset file. Include the `.xml` file name extension. This parameter does not accept the wildcard character (*)." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path", + "description": "Specifies an absolute path for an asset file. Include the `.xml` file name extension. This parameter does not accept the wildcard character (*)." + } + ], + "description": "Exports secondary tiles for Microsoft Edge that display a custom image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/export-tlssessionticketkey.json b/command-signatures/json/autogenerated/powershell/export-tlssessionticketkey.json new file mode 100644 index 00000000..ed3168a5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/export-tlssessionticketkey.json @@ -0,0 +1,241 @@ +{ + "name": "Export-TlsSessionTicketKey", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Password", + "args": [ + { + "name": "System.Security.SecureString" + } + ], + "isRequired": true, + "description": "Specifies the password, as a secure string, for the key." + }, + { + "name": [ + "-Path", + "-FullName" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the path of the configuration file for the TLS server." + }, + { + "name": "-ServiceAccountName", + "args": [ + { + "name": "System.Security.Principal.NTAccount" + } + ], + "isRequired": true, + "description": "Specifies the name of a service account. The cmdlet exports the configuration of the TLS session ticket key for the service account. Only System, LocalService, NetworkService, and SID of virtual accounts are supported." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Password", + "description": "Specifies the password, as a secure string, for the key." + }, + { + "name": "-Path", + "description": "Specifies the path of the configuration file for the TLS server." + }, + { + "name": "-ServiceAccountName", + "description": "Specifies the name of a service account. The cmdlet exports the configuration of the TLS session ticket key for the service account. Only System, LocalService, NetworkService, and SID of virtual accounts are supported." + } + ], + "description": "Exports a TLS session ticket key.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/export-trace.json b/command-signatures/json/autogenerated/powershell/export-trace.json new file mode 100644 index 00000000..695000e0 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/export-trace.json @@ -0,0 +1,238 @@ +{ + "name": "Export-Trace", + "options": [ + { + "name": [ + "-ConnectedDevice", + "-Device" + ], + "description": "If enabled, specifies that the device type is mobile." + }, + { + "name": [ + "-ETLFile", + "-Etl" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the ETL file location." + }, + { + "name": [ + "-LogsDirectoryPath", + "-Logs" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the logs directory path." + }, + { + "name": [ + "-Overwrite", + "-Force, Overwrite" + ], + "description": "Indicates that the cmdlet overwrites an existing exported log if one exists." + }, + { + "name": [ + "-WprpFile", + "-Wprp" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location of the WPR profile file." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ETLFile", + "description": "Specifies the ETL file location." + } + ], + "description": "Exports an event trace log file for provisioning.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/export-windowscapabilitysource.json b/command-signatures/json/autogenerated/powershell/export-windowscapabilitysource.json new file mode 100644 index 00000000..85ca2569 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/export-windowscapabilitysource.json @@ -0,0 +1,286 @@ +{ + "name": "Export-WindowsCapabilitySource", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Name", + "args": [ + { + "name": "String" + } + ], + "description": "The name of the capability that you're exporting packages for." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-Source", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "The location that contains packages, such as a mounted Languages and Optional Features ISO or a custom FOD repository." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-Target", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "The destination for the FOD repository." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Creates a custom FOD repository that includes packages that support the installation of the specified capabilities. See [FOD repositories](/windows-hardware/manufacture/desktop/features-on-demand-v2--capabilities#fod-repositories) for more information.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/export-windowsdriver.json b/command-signatures/json/autogenerated/powershell/export-windowsdriver.json new file mode 100644 index 00000000..48502301 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/export-windowsdriver.json @@ -0,0 +1,271 @@ +{ + "name": "Export-WindowsDriver", + "options": [ + { + "name": "-Destination", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a directory the exported third-party drivers will be stored." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Exports all third-party drivers from a Windows image to a destination folder.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/export-windowsimage.json b/command-signatures/json/autogenerated/powershell/export-windowsimage.json new file mode 100644 index 00000000..ccf4c750 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/export-windowsimage.json @@ -0,0 +1,326 @@ +{ + "name": "Export-WindowsImage", + "options": [ + { + "name": "-CheckIntegrity", + "description": "Detects and tracks .wim file corruption when used with the Add-WindowsImage, Dismount-WindowsImage, or Save-WindowsImage cmdlet. CheckIntegrity stops the operation if DISM detects that the .wim file is corrupted when used with the Expand-WindowsImage or Mount-WindowsImage cmdlet." + }, + { + "name": "-CompressionType", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the type of compression used for the initial capture operation. Acceptable values are:" + }, + { + "name": [ + "-DestinationImagePath", + "-DIP" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location of the exported image file." + }, + { + "name": [ + "-DestinationName", + "-DN" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of the exported image in the exported image file." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": [ + "-Setbootable", + "-SB" + ], + "description": "Marks a volume image as being a bootable image. This argument is available only for Windows PE images. Only one volume image can be marked as bootable in a .wim file." + }, + { + "name": [ + "-SourceImagePath", + "-SIP" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location of the source image file. Must be used in conjunction with `-SourceIndex` or `-SourceName`. If the source file is a SWM file, `-SplitImageFilePattern` is also required." + }, + { + "name": [ + "-SourceIndex", + "-SI" + ], + "args": [ + { + "name": "UInt32" + } + ], + "isRequired": true, + "description": "Specifies the index number of a Windows image in a WIM or VHD file. For a VHD file, the Index must be 1." + }, + { + "name": [ + "-SourceName", + "-SN" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the name of the source image in the source image file." + }, + { + "name": "-SplitImageFilePattern", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location and name of the base split image file." + }, + { + "name": "-WIMBoot", + "description": "Specifies that the image will be formatted to install on a Windows image file boot (WIMBoot) system." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Exports a copy of the specified image to another image file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/find-lapsadextendedrights.json b/command-signatures/json/autogenerated/powershell/find-lapsadextendedrights.json new file mode 100644 index 00000000..afda13e9 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/find-lapsadextendedrights.json @@ -0,0 +1,223 @@ +{ + "name": "Find-LapsADExtendedRights", + "options": [ + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies the credentials to use when updating AD. If not specified, the current user's credentials are used." + }, + { + "name": "-Domain", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the domain to connect to." + }, + { + "name": "-DomainController", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the domain controller to connect to." + }, + { + "name": "-Identity", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the name of the OU to query." + }, + { + "name": "-IncludeComputers", + "description": "Specify this parameter to also check computer objects for the permissions." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Queries Active Directory (AD) to find principals that have been granted permission to read Windows Local Administrator Password Solution (LAPS) password attributes.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/find-package.json b/command-signatures/json/autogenerated/powershell/find-package.json index c80d4a2d..c9830a41 100644 --- a/command-signatures/json/autogenerated/powershell/find-package.json +++ b/command-signatures/json/autogenerated/powershell/find-package.json @@ -121,7 +121,7 @@ ] } ], - "description": "Specifies whether `Find-Package` should find all packages within a category.\n" + "description": "Specifies whether `Find-Package` should find all packages within a category." }, { "name": "-MaximumVersion", diff --git a/command-signatures/json/autogenerated/powershell/find-psresource.json b/command-signatures/json/autogenerated/powershell/find-psresource.json index 4912e153..e2431c5a 100644 --- a/command-signatures/json/autogenerated/powershell/find-psresource.json +++ b/command-signatures/json/autogenerated/powershell/find-psresource.json @@ -54,7 +54,7 @@ "name": "System.String[]" } ], - "description": "Specifies one or more repository names to search. If not specified, search includes all registered repositories, in priority order (highest first), until a repository is found that contains the package. Repositories are sorted by priority then by name. Lower Priority values have a higher precedence.\n" + "description": "Specifies one or more repository names to search. If not specified, search includes all registered repositories, in priority order (highest first), until a repository is found that contains the package. Repositories are sorted by priority then by name. Lower Priority values have a higher precedence." }, { "name": "-Tag", @@ -71,11 +71,14 @@ { "name": "Microsoft.PowerShell.PSResourceGet.UtilClasses.ResourceType", "suggestions": [ + { + "name": "Module" + }, { "name": "None" }, { - "name": "Module" + "name": "Nupkg" }, { "name": "Script" @@ -83,7 +86,7 @@ ] } ], - "description": "Specifies one or more resource types to find. Resource types supported are:\n" + "description": "Specifies one or more resource types to find. Resource types supported are:" }, { "name": "-Version", @@ -92,7 +95,7 @@ "name": "System.String" } ], - "description": "Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax.\n" + "description": "Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/foreach-object.json b/command-signatures/json/autogenerated/powershell/foreach-object.json index bf49a400..5d4cda37 100644 --- a/command-signatures/json/autogenerated/powershell/foreach-object.json +++ b/command-signatures/json/autogenerated/powershell/foreach-object.json @@ -11,11 +11,11 @@ "name": "System.Object[]" } ], - "description": "Specifies an array of arguments to a method call. For more information about the behavior of ArgumentList , see about_Splatting (about/about_Splatting.md#splatting-with-arrays).\n" + "description": "Specifies an array of arguments to a method call. For more information about the behavior of ArgumentList, see [about_Splatting](about/about_Splatting.md#splatting-with-arrays)." }, { "name": "-AsJob", - "description": "Causes the parallel invocation to run as a PowerShell job. A single job object is returned instead of output from the running script blocks. The job object contains child jobs for each parallel script block that runs. The job object can be used by all PowerShell job cmdlets, to monitor running state and retrieve data.\n" + "description": "Causes the parallel invocation to run as a PowerShell job. A single job object is returned instead of output from the running scriptblocks. The job object contains child jobs for each parallel scriptblock that runs. You can use the job object with any of the PowerShell job cmdlets to see the running state and retrieve data." }, { "name": "-Begin", @@ -24,7 +24,14 @@ "name": "System.Management.Automation.ScriptBlock" } ], - "description": "Specifies a script block that runs before this cmdlet processes any input objects. This script block is only run once for the entire pipeline. For more information about the `begin` block, see about_Functions (about/about_functions.md#piping-objects-to-functions)." + "description": "Specifies a scriptblock that runs before this cmdlet processes any input objects. This scriptblock is only run once for the entire pipeline. For more information about the `begin` block, see [about_Functions](about/about_functions.md#piping-objects-to-functions)." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-End", @@ -33,7 +40,7 @@ "name": "System.Management.Automation.ScriptBlock" } ], - "description": "Specifies a script block that runs after this cmdlet processes all input objects. This script block is only run once for the entire pipeline. For more information about the `end` block, see about_Functions (about/about_functions.md#piping-objects-to-functions)." + "description": "Specifies a scriptblock that runs after this cmdlet processes all input objects. This scriptblock is only run once for the entire pipeline. For more information about the `end` block, see [about_Functions](about/about_functions.md#piping-objects-to-functions)." }, { "name": "-InputObject", @@ -42,7 +49,7 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies the input objects. `ForEach-Object` runs the script block or operation statement on each input object. Enter a variable that contains the objects, or type a command or expression that gets the objects.\n" + "description": "Specifies the input objects. `ForEach-Object` runs the scriptblock or operation statement on each input object. Enter a variable that contains the objects, or type a command or expression that gets the objects." }, { "name": "-MemberName", @@ -52,7 +59,7 @@ } ], "isRequired": true, - "description": "Specifies the property to get or the method to call.\n" + "description": "Specifies the name of the member property to get or the member method to call. The members must be instance members, not static members." }, { "name": "-Parallel", @@ -62,7 +69,7 @@ } ], "isRequired": true, - "description": "Specifies the script block to be used for parallel processing of input objects. Enter a script block that describes the operation.\n" + "description": "Specifies the scriptblock to be used for parallel processing of input objects. Enter a scriptblock that describes the operation." }, { "name": "-Process", @@ -72,7 +79,7 @@ } ], "isRequired": true, - "description": "Specifies the operation that's performed on each input object. This script block is run for every object in the pipeline. For more information about the `process` block, see about_Functions (about/about_functions.md#piping-objects-to-functions).\n" + "description": "Specifies the operation that's performed on each input object. This scriptblock is run for every object in the pipeline. For more information about the `process` block, see [about_Functions](about/about_functions.md#piping-objects-to-functions)." }, { "name": "-RemainingScripts", @@ -81,38 +88,29 @@ "name": "System.Management.Automation.ScriptBlock[]" } ], - "description": "Specifies all script blocks that aren't taken by the Process parameter.\n" + "description": "Specifies all scriptblocks that aren't taken by the Process parameter." }, { "name": "-ThrottleLimit", "args": [ { - "name": "System.Int32", - "default": "5" + "name": "System.Int32" } ], - "description": "Specifies the number of script blocks that run in parallel. Input objects are blocked until the running script block count falls below the ThrottleLimit . The default value is `5`.\n" + "description": "Specifies the number of scriptblocks that run in parallel. Input objects are blocked until the running scriptblock count falls below the ThrottleLimit. The default value is `5`." }, { "name": "-TimeoutSeconds", "args": [ { - "name": "System.Int32", - "default": "0" + "name": "System.Int32" } ], - "description": "Specifies the number of seconds to wait for all input to be processed in parallel. After the specified timeout time, all running scripts are stopped. And any remaining input objects to be processed are ignored. Default value of `0` disables the timeout, and `ForEach-Object -Parallel` can run indefinitely. Typing Ctrl+C at the command line stops a running `ForEach-Object -Parallel` command. This parameter can't be used along with the AsJob parameter.\n" + "description": "Specifies the number of seconds to wait for all input to be processed in parallel. After the specified timeout time, all running scripts are stopped. And any remaining input objects to be processed are ignored. Default value of `0` disables the timeout, and `ForEach-Object -Parallel` can run indefinitely. Typing Ctrl+C at the command line stops a running `ForEach-Object -Parallel` command. This parameter can't be used along with the AsJob parameter." }, { "name": "-UseNewRunspace", - "description": "Causes the parallel invocation to create a new runspace for every loop iteration instead of reusing runspaces from the runspace pool.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Causes the parallel invocation to create a new runspace for every loop iteration instead of reusing runspaces from the runspace pool." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/format-custom.json b/command-signatures/json/autogenerated/powershell/format-custom.json index dab2ddef..5a4b8b68 100644 --- a/command-signatures/json/autogenerated/powershell/format-custom.json +++ b/command-signatures/json/autogenerated/powershell/format-custom.json @@ -21,19 +21,18 @@ "name": "System.String", "suggestions": [ { - "name": "CoreOnly" + "name": "Both" }, { - "name": "EnumOnly" + "name": "CoreOnly" }, { - "name": "Both" + "name": "EnumOnly" } - ], - "default": "EnumOnly" + ] } ], - "description": "Formats the collection object, as well as the objects in the collection. This parameter is designed to format objects that support the System.Collections.ICollection interface. The default value is EnumOnly .\n" + "description": "Formats the collection object, as well as the objects in the collection. This parameter is designed to format objects that support the System.Collections.ICollection interface. The default value is EnumOnly." }, { "name": "-Force", @@ -46,7 +45,7 @@ "name": "System.Object" } ], - "description": "Formats the output in groups based on a shared property or value. Enter an expression or a property of the output.\n" + "description": "Formats the output in groups based on a shared property or value. Enter an expression or a property of the output. The GroupBy parameter expects that the objects are sorted. Use the `Sort-Object` cmdlet before using `Format-Custom` to group the objects." }, { "name": "-InputObject", @@ -64,7 +63,7 @@ "name": "System.Object[]" } ], - "description": "Specifies the object properties that appear in the display and the order in which they appear. Wildcards are permitted.\n" + "description": "Specifies the object properties that appear in the display and the order in which they appear. Wildcards are permitted." }, { "name": "-ShowError", @@ -253,7 +252,7 @@ "args": [ { "name": "-Property", - "description": "Specifies the object properties that appear in the display and the order in which they appear. Wildcards are permitted.\n" + "description": "Specifies the object properties that appear in the display and the order in which they appear. Wildcards are permitted." } ], "description": "Uses a customized view to format the output.", diff --git a/command-signatures/json/autogenerated/powershell/format-hex.json b/command-signatures/json/autogenerated/powershell/format-hex.json index 5932d523..b86ed30c 100644 --- a/command-signatures/json/autogenerated/powershell/format-hex.json +++ b/command-signatures/json/autogenerated/powershell/format-hex.json @@ -5,11 +5,10 @@ "name": "-Count", "args": [ { - "name": "System.Int64", - "default": "Int64.MaxValue" + "name": "System.Int64" } ], - "description": "This represents the number of bytes to include in the hex output.\n" + "description": "This represents the number of bytes to include in the hex output." }, { "name": "-Encoding", @@ -18,40 +17,42 @@ "name": "System.Text.Encoding", "suggestions": [ { - "name": "ASCII" + "name": "ansi" }, { - "name": "BigEndianUnicode" + "name": "ascii" }, { - "name": "BigEndianUTF32" + "name": "bigendianunicode" }, { - "name": "OEM" + "name": "bigendianutf32" }, { - "name": "Unicode" + "name": "oem" }, { - "name": "UTF7" + "name": "unicode" }, { - "name": "UTF8" + "name": "utf32" }, { - "name": "UTF8BOM" + "name": "utf7" }, { - "name": "UTF8NoBOM" + "name": "utf8" }, { - "name": "UTF32" + "name": "utf8BOM" + }, + { + "name": "utf8NoBOM" } - ], - "default": "UTF8NoBOM" + ] } ], - "description": "Specifies the encoding of the input strings. This only applies to `[string]` input. The parameter has no effect on numeric types. The output value is always `utf8NoBOM`.\n" + "description": "Specifies the encoding of the input strings. This only applies to `[string]` input. The parameter has no effect on numeric types. The output value is always `utf8NoBOM`." }, { "name": "-InputObject", @@ -61,7 +62,7 @@ } ], "isRequired": true, - "description": "Specifies the objects to be formatted. Enter a variable that contains the objects or type a command or expression that gets the objects.\n" + "description": "Specifies the objects to be formatted. Enter a variable that contains the objects or type a command or expression that gets the objects." }, { "name": [ @@ -75,17 +76,16 @@ } ], "isRequired": true, - "description": "Specifies the complete path to a file. The value of LiteralPath is used exactly as it is typed. This parameter does not accept wildcard characters. To specify multiple paths to files, separate the paths with a comma. If the LiteralPath parameter includes escape characters, enclose the path in single quotation marks. PowerShell does not interpret any characters in a single quoted string as escape sequences. For more information, see about_Quoting_Rules (../Microsoft.Powershell.Core/About/about_Quoting_Rules.md)." + "description": "Specifies the complete path to a file. The value of LiteralPath is used exactly as it is typed. This parameter does not accept wildcard characters. To specify multiple paths to files, separate the paths with a comma. If the LiteralPath parameter includes escape characters, enclose the path in single quotation marks. PowerShell does not interpret any characters in a single quoted string as escape sequences. For more information, see [about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md)." }, { "name": "-Offset", "args": [ { - "name": "System.Int64", - "default": "0" + "name": "System.Int64" } ], - "description": "This represents the number of bytes to skip from being part of the hex output.\n" + "description": "This represents the number of bytes to skip from being part of the hex output." }, { "name": "-Path", @@ -95,7 +95,7 @@ } ], "isRequired": true, - "description": "Specifies the path to files. Use a dot (`.`) to specify the current location. The wildcard character (` `) is accepted and can be used to specify all the items in a location. If the Path * parameter includes escape characters, enclose the path in single quotation marks. To specify multiple paths to files, separate the paths with a comma." + "description": "Specifies the path to files. Use a dot (`.`) to specify the current location. The wildcard character (`*`) is accepted and can be used to specify all the items in a location. If the Path parameter includes escape characters, enclose the path in single quotation marks. To specify multiple paths to files, separate the paths with a comma." }, { "name": "-Raw", @@ -275,7 +275,7 @@ "args": [ { "name": "-Path", - "description": "Specifies the path to files. Use a dot (`.`) to specify the current location. The wildcard character (` `) is accepted and can be used to specify all the items in a location. If the Path * parameter includes escape characters, enclose the path in single quotation marks. To specify multiple paths to files, separate the paths with a comma." + "description": "Specifies the path to files. Use a dot (`.`) to specify the current location. The wildcard character (`*`) is accepted and can be used to specify all the items in a location. If the Path parameter includes escape characters, enclose the path in single quotation marks. To specify multiple paths to files, separate the paths with a comma." } ], "description": "Displays a file or other input as hexadecimal.", diff --git a/command-signatures/json/autogenerated/powershell/format-list.json b/command-signatures/json/autogenerated/powershell/format-list.json index 287bd01b..1188f4fe 100644 --- a/command-signatures/json/autogenerated/powershell/format-list.json +++ b/command-signatures/json/autogenerated/powershell/format-list.json @@ -12,22 +12,22 @@ "name": "System.String", "suggestions": [ { - "name": "CoreOnly" + "name": "Both" }, { - "name": "EnumOnly" + "name": "CoreOnly" }, { - "name": "Both" + "name": "EnumOnly" } ] } ], - "description": "Specifies the formatted collection object, as well as the objects in the collection. This parameter is designed to format objects that support the System.Collections.ICollection interface. The default value is `EnumOnly`. The acceptable values for this parameter are:\n" + "description": "Specifies the formatted collection object, as well as the objects in the collection. This parameter is designed to format objects that support the System.Collections.ICollection interface. The default value is `EnumOnly`. The acceptable values for this parameter are:" }, { "name": "-Force", - "description": "Indicates that this cmdlet displays all the error information. Use with the DisplayError or ShowError parameter. By default, when an error object is written to the error or display streams, only some error information is displayed.\n" + "description": "Indicates that this cmdlet displays all the error information. Use with the DisplayError or ShowError parameter. By default, when an error object is written to the error or display streams, only some error information is displayed." }, { "name": "-GroupBy", @@ -36,7 +36,7 @@ "name": "System.Object" } ], - "description": "Specifies the output in groups based on a shared property or value. Enter an expression or a property of the output.\n" + "description": "Specifies the output in groups based on a shared property or value. Enter an expression or a property of the output. The GroupBy parameter expects that the objects are sorted. Use the `Sort-Object` cmdlet before using `Format-List` to group the objects." }, { "name": "-InputObject", @@ -54,7 +54,7 @@ "name": "System.Object[]" } ], - "description": "Specifies the object properties that appear in the display and the order in which they appear. Wildcards are permitted.\n" + "description": "Specifies the object properties that appear in the display and the order in which they appear. Wildcards are permitted." }, { "name": "-ShowError", @@ -243,7 +243,7 @@ "args": [ { "name": "-Property", - "description": "Specifies the object properties that appear in the display and the order in which they appear. Wildcards are permitted.\n" + "description": "Specifies the object properties that appear in the display and the order in which they appear. Wildcards are permitted." } ], "description": "Formats the output as a list of properties in which each property appears on a new line.", diff --git a/command-signatures/json/autogenerated/powershell/format-securebootuefi.json b/command-signatures/json/autogenerated/powershell/format-securebootuefi.json new file mode 100644 index 00000000..91d8bb32 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/format-securebootuefi.json @@ -0,0 +1,333 @@ +{ + "name": "Format-SecureBootUEFI", + "options": [ + { + "name": [ + "-Algorithm", + "-alg" + ], + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "sha1" + }, + { + "name": "sha256" + }, + { + "name": "sha384" + }, + { + "name": "sha512" + } + ] + } + ], + "isRequired": true, + "description": "Specifies which algorithm to use if this cmdlet is formatting hashes. The acceptable values for this parameter are: SHA1, SHA256, SHA384, and SHA512." + }, + { + "name": [ + "-AppendWrite", + "-append" + ], + "description": "Indicates that the contents of the current variable are appended instead of overwritten." + }, + { + "name": [ + "-CertificateFilePath", + "-c" + ], + "args": [ + { + "name": "String[]" + } + ], + "isRequired": true, + "description": "Specifies one or more files that each contain a certificate that is used to generate the content object." + }, + { + "name": [ + "-ContentFilePath", + "-f" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of the file that is created and contains the information for the content object that is generated by this cmdlet." + }, + { + "name": [ + "-Delete", + "-del" + ], + "isRequired": true, + "description": "Indicates that this cmdlet creates a content object and the appropriate sign-able file that deletes the variable." + }, + { + "name": [ + "-FormatWithCert", + "-cert" + ], + "description": "Indicates whether the certificate will be stored or just the public key. If this parameter is set, the whole certificate is stored in the content object." + }, + { + "name": [ + "-Hash", + "-h" + ], + "args": [ + { + "name": "String[]" + } + ], + "isRequired": true, + "description": "Specifies an array of hashes that are used to generate the content." + }, + { + "name": [ + "-Name", + "-n" + ], + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "db" + }, + { + "name": "dbx" + }, + { + "name": "KEK" + }, + { + "name": "PK" + } + ] + } + ], + "isRequired": true, + "description": "Specifies the name of the UEFI environment variable. The acceptable values for this parameter are: PK, KEK, DB, and DBX." + }, + { + "name": [ + "-SignableFilePath", + "-s" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the file that contains the contents of the data that is ready to be signed." + }, + { + "name": [ + "-SignatureOwner", + "-g" + ], + "args": [ + { + "name": "Guid" + } + ], + "isRequired": true, + "description": "Specifies the GUID of the signature owner." + }, + { + "name": [ + "-Time", + "-t" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the timestamp that is used in the signature. Format this value as follows so that it is accepted as a DateTime object:" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Formats certificates or hashes into a content object that is returned and creates a file that is ready to be signed.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/format-table.json b/command-signatures/json/autogenerated/powershell/format-table.json index 50b78c54..a525a5cd 100644 --- a/command-signatures/json/autogenerated/powershell/format-table.json +++ b/command-signatures/json/autogenerated/powershell/format-table.json @@ -16,22 +16,22 @@ "name": "System.String", "suggestions": [ { - "name": "CoreOnly" + "name": "Both" }, { - "name": "EnumOnly" + "name": "CoreOnly" }, { - "name": "Both" + "name": "EnumOnly" } ] } ], - "description": "Specifies the format of the collection object and the objects in the collection. This parameter is designed to format objects that support the ICollection (/dotnet/api/system.collections.icollection)( System.Collections (/dotnet/api/system.collections))interface. The default value is EnumOnly . The acceptable values for this parameter are as follows:\n" + "description": "Specifies the format of the collection object and the objects in the collection. This parameter is designed to format objects that support the [ICollection](xref:System.Collections.ICollection)([System.Collections](xref:System.Collections)) interface. The default value is EnumOnly. The acceptable values for this parameter are as follows:" }, { "name": "-Force", - "description": "Indicates that the cmdlet directs the cmdlet to display all the error information. Use with the DisplayError or ShowError parameter. By default, when an error object is written to the error or display streams, only some error information is displayed.\n" + "description": "Indicates that the cmdlet directs the cmdlet to display all the error information. Use with the DisplayError or ShowError parameter. By default, when an error object is written to the error or display streams, only some error information is displayed." }, { "name": "-GroupBy", @@ -40,7 +40,7 @@ "name": "System.Object" } ], - "description": "Specifies sorted output in separate tables based on a property value. For example, you can use GroupBy to list services in separate tables based on their status.\n" + "description": "Specifies sorted output in separate tables based on a property value. For example, you can use GroupBy to list services in separate tables based on their status." }, { "name": "-HideTableHeaders", @@ -62,7 +62,7 @@ "name": "System.Object[]" } ], - "description": "Specifies the object properties that appear in the display and the order in which they appear. Type one or more property names, separated by commas, or use a hash table to display a calculated property. Wildcards are permitted.\n" + "description": "Specifies the object properties that appear in the display and the order in which they appear. Type one or more property names, separated by commas, or use a hash table to display a calculated property. Wildcards are permitted." }, { "name": "-RepeatHeader", @@ -79,7 +79,7 @@ "name": "System.String" } ], - "description": "Beginning in PowerShell 6, the default views are defined in PowerShell `C#` source code. The `*.format.ps1xml` files from PowerShell 5.1 and earlier versions don't exist in PowerShell 6 and later versions.\n" + "description": "Beginning in PowerShell 6, the default views are defined in PowerShell `C#` source code. The `*.format.ps1xml` files from PowerShell 5.1 and earlier versions don't exist in PowerShell 6 and later versions." }, { "name": "-Wrap", @@ -259,7 +259,7 @@ "args": [ { "name": "-Property", - "description": "Specifies the object properties that appear in the display and the order in which they appear. Type one or more property names, separated by commas, or use a hash table to display a calculated property. Wildcards are permitted.\n" + "description": "Specifies the object properties that appear in the display and the order in which they appear. Type one or more property names, separated by commas, or use a hash table to display a calculated property. Wildcards are permitted." } ], "description": "Formats the output as a table.", diff --git a/command-signatures/json/autogenerated/powershell/format-wide.json b/command-signatures/json/autogenerated/powershell/format-wide.json index d5ef94f5..730e3154 100644 --- a/command-signatures/json/autogenerated/powershell/format-wide.json +++ b/command-signatures/json/autogenerated/powershell/format-wide.json @@ -25,19 +25,18 @@ "name": "System.String", "suggestions": [ { - "name": "CoreOnly" + "name": "Both" }, { - "name": "EnumOnly" + "name": "CoreOnly" }, { - "name": "Both" + "name": "EnumOnly" } - ], - "default": "EnumOnly" + ] } ], - "description": "Formats the collection object, as well as the objects in the collection. This parameter is designed to format objects that support the System.Collections.ICollection interface. The default value is `EnumOnly`.\n" + "description": "Formats the collection object, as well as the objects in the collection. This parameter is designed to format objects that support the System.Collections.ICollection interface. The default value is `EnumOnly`." }, { "name": "-Force", @@ -50,7 +49,7 @@ "name": "System.Object" } ], - "description": "Formats the output in groups based on a shared property or value. Enter an expression or a property of the output.\n" + "description": "Formats the output in groups based on a shared property or value. Enter an expression or a property of the output. The GroupBy parameter expects that the objects are sorted. Use the `Sort-Object` cmdlet before using `Format-Wide` to group the objects." }, { "name": "-InputObject", @@ -68,7 +67,7 @@ "name": "System.Object" } ], - "description": "Specifies the object property that appears in the display. Wildcards are permitted.\n" + "description": "Specifies the object property that appears in the display. Wildcards are permitted." }, { "name": "-ShowError", @@ -257,7 +256,7 @@ "args": [ { "name": "-Property", - "description": "Specifies the object property that appears in the display. Wildcards are permitted.\n" + "description": "Specifies the object property that appears in the display. Wildcards are permitted." } ], "description": "Formats objects as a wide table that displays only one property of each object.", diff --git a/command-signatures/json/autogenerated/powershell/get-acl.json b/command-signatures/json/autogenerated/powershell/get-acl.json new file mode 100644 index 00000000..0fc1f245 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-acl.json @@ -0,0 +1,250 @@ +{ + "name": "Get-Acl", + "options": [ + { + "name": "-Audit", + "description": "Gets the audit data for the security descriptor from the system access control list (SACL)." + }, + { + "name": "-Exclude", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Omits the specified items. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcards are permitted." + }, + { + "name": "-Filter", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a filter in the provider's format or language. The value of this parameter qualifies the Path parameter. The syntax of the filter, including the use of wildcards, depends on the provider. Filters are more efficient than other parameters, because the provider applies them when getting the objects, rather than having PowerShell filter the objects after they are retrieved." + }, + { + "name": "-Include", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Gets only the specified items. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcards are permitted." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "System.Management.Automation.PSObject" + } + ], + "isRequired": true, + "description": "Gets the security descriptor for the specified object. Enter a variable that contains the object or a command that gets the object." + }, + { + "name": [ + "-LiteralPath", + "-PSPath", + "-LP" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the path to a resource. Unlike Path, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + }, + { + "name": "-Path", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the path to a resource. `Get-Acl` gets the security descriptor of the resource indicated by the path. Wildcards are permitted. If you omit the Path parameter, `Get-Acl` gets the security descriptor of the current directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path", + "description": "Specifies the path to a resource. `Get-Acl` gets the security descriptor of the resource indicated by the path. Wildcards are permitted. If you omit the Path parameter, `Get-Acl` gets the security descriptor of the current directory." + } + ], + "description": "Gets the security descriptor for a resource, such as a file or registry key.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-alias.json b/command-signatures/json/autogenerated/powershell/get-alias.json index dbac22c3..0e646bc9 100644 --- a/command-signatures/json/autogenerated/powershell/get-alias.json +++ b/command-signatures/json/autogenerated/powershell/get-alias.json @@ -8,7 +8,7 @@ "name": "System.String[]" } ], - "description": "Gets the aliases for the specified item. Enter the name of a cmdlet, function, script, file, or executable file.\n" + "description": "Gets the aliases for the specified item. Enter the name of a cmdlet, function, script, file, or executable file." }, { "name": "-Exclude", @@ -23,8 +23,7 @@ "name": "-Name", "args": [ { - "name": "System.String[]", - "default": "All aliases" + "name": "System.String[]" } ], "description": "Specifies the aliases that this cmdlet gets. Wildcards are permitted. By default, `Get-Alias` retrieves all aliases defined for the current session. The parameter name Name is optional. You can also pipe alias names to `Get-Alias`." @@ -33,11 +32,10 @@ "name": "-Scope", "args": [ { - "name": "System.String", - "default": "Local" + "name": "System.String" } ], - "description": "Specifies the scope for which this cmdlet gets aliases. The acceptable values for this parameter are:\n" + "description": "Specifies the scope for which this cmdlet gets aliases. The acceptable values for this parameter are:" }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/get-appprovisionedsharedpackagecontainer.json b/command-signatures/json/autogenerated/powershell/get-appprovisionedsharedpackagecontainer.json new file mode 100644 index 00000000..08fe8425 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-appprovisionedsharedpackagecontainer.json @@ -0,0 +1,255 @@ +{ + "name": "Get-AppProvisionedSharedPackageContainer", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + }, + { + "name": "Debug" + } + ] + } + ] + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Online", + "isRequired": true + }, + { + "name": "-Path", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Get-AppProvisionedSharedPackageContainer -Path [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] Get-AppProvisionedSharedPackageContainer -Online [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-appsharedpackagecontainer.json b/command-signatures/json/autogenerated/powershell/get-appsharedpackagecontainer.json new file mode 100644 index 00000000..a1804ead --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-appsharedpackagecontainer.json @@ -0,0 +1,205 @@ +{ + "name": "Get-AppSharedPackageContainer", + "options": [ + { + "name": "-Id", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Name", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name" + }, + { + "name": "-Id" + } + ], + "description": "Get-AppSharedPackageContainer [[-Name] ] [[-Id] ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-appxdefaultvolume.json b/command-signatures/json/autogenerated/powershell/get-appxdefaultvolume.json new file mode 100644 index 00000000..f2671782 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-appxdefaultvolume.json @@ -0,0 +1,182 @@ +{ + "name": "Get-AppxDefaultVolume", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Get-AppxDefaultVolume []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-appxpackage.json b/command-signatures/json/autogenerated/powershell/get-appxpackage.json new file mode 100644 index 00000000..c6e7c3c5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-appxpackage.json @@ -0,0 +1,258 @@ +{ + "name": "Get-AppxPackage", + "options": [ + { + "name": "-AllUsers" + }, + { + "name": "-Name", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-PackageTypeFilter", + "args": [ + { + "name": "PackageTypes", + "suggestions": [ + { + "name": "None" + }, + { + "name": "Main" + }, + { + "name": "Framework" + }, + { + "name": "Resource" + }, + { + "name": "Bundle" + }, + { + "name": "Xap" + }, + { + "name": "Optional" + }, + { + "name": "All" + } + ] + } + ] + }, + { + "name": "-Publisher", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-User", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Volume", + "args": [ + { + "name": "AppxVolume" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name" + }, + { + "name": "-Publisher" + } + ], + "description": "Get-AppxPackage [[-Name] ] [[-Publisher] ] [-AllUsers] [-PackageTypeFilter ] [-User ] [-Volume ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-appxpackageautoupdatesettings.json b/command-signatures/json/autogenerated/powershell/get-appxpackageautoupdatesettings.json new file mode 100644 index 00000000..085d54e3 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-appxpackageautoupdatesettings.json @@ -0,0 +1,200 @@ +{ + "name": "Get-AppxPackageAutoUpdateSettings", + "options": [ + { + "name": "-AllUsers" + }, + { + "name": "-PackageFamilyName", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-ShowUpdateAvailability" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-PackageFamilyName" + } + ], + "description": "Get-AppxPackageAutoUpdateSettings [[-PackageFamilyName] ] [-ShowUpdateAvailability] [-AllUsers] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-appxpackagemanifest.json b/command-signatures/json/autogenerated/powershell/get-appxpackagemanifest.json new file mode 100644 index 00000000..ec546ee0 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-appxpackagemanifest.json @@ -0,0 +1,206 @@ +{ + "name": "Get-AppxPackageManifest", + "options": [ + { + "name": "-Package", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-User", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Package" + }, + { + "name": "-User" + } + ], + "description": "Get-AppxPackageManifest [-Package] [[-User] ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-appxprovisionedpackage.json b/command-signatures/json/autogenerated/powershell/get-appxprovisionedpackage.json new file mode 100644 index 00000000..a96dbccb --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-appxprovisionedpackage.json @@ -0,0 +1,262 @@ +{ + "name": "Get-AppxProvisionedPackage", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets information about app packages (.appx) in an image that will be installed for each new user.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-appxvolume.json b/command-signatures/json/autogenerated/powershell/get-appxvolume.json new file mode 100644 index 00000000..a72dd5b2 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-appxvolume.json @@ -0,0 +1,202 @@ +{ + "name": "Get-AppxVolume", + "options": [ + { + "name": "-Offline", + "isRequired": true + }, + { + "name": "-Online", + "isRequired": true + }, + { + "name": "-Path", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path" + } + ], + "description": "Get-AppxVolume [[-Path] ] [] Get-AppxVolume -Online [-Path ] [] Get-AppxVolume -Offline [-Path ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-authenticodesignature.json b/command-signatures/json/autogenerated/powershell/get-authenticodesignature.json new file mode 100644 index 00000000..60fe212a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-authenticodesignature.json @@ -0,0 +1,231 @@ +{ + "name": "Get-AuthenticodeSignature", + "options": [ + { + "name": "-Content", + "args": [ + { + "name": "System.Byte[]" + } + ], + "isRequired": true, + "description": "Contents of a file as a byte array for which the Authenticode signature is retrieved. This parameter must be used with SourcePathOrExtension parameter. Prior to PowerShell 7.4, the contents of the file must be in Unicode (UTF-16LE) format." + }, + { + "name": "-FilePath", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the path to the file to examine. Wildcards are permitted, but they must lead to a single file. It is not necessary to type FilePath at the command line when you specify a value for this parameter." + }, + { + "name": [ + "-LiteralPath", + "-PSPath", + "-LP" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the path to the file being examined. Unlike FilePath, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes an escape character, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape characters." + }, + { + "name": "-SourcePathOrExtension", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Path to the file or file type of the content for which the Authenticode signature is retrieved. This parameter is used with Content where file content is passed as a byte array." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-FilePath", + "description": "Specifies the path to the file to examine. Wildcards are permitted, but they must lead to a single file. It is not necessary to type FilePath at the command line when you specify a value for this parameter." + } + ], + "description": "Gets information about the Authenticode signature for a file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-bcdentry.json b/command-signatures/json/autogenerated/powershell/get-bcdentry.json new file mode 100644 index 00000000..9e104168 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-bcdentry.json @@ -0,0 +1,226 @@ +{ + "name": "Get-BcdEntry", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Id", + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-bcdentrydebugsettings.json b/command-signatures/json/autogenerated/powershell/get-bcdentrydebugsettings.json new file mode 100644 index 00000000..2f78b874 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-bcdentrydebugsettings.json @@ -0,0 +1,210 @@ +{ + "name": "Get-BcdEntryDebugSettings", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-bcdentryhypervisorsettings.json b/command-signatures/json/autogenerated/powershell/get-bcdentryhypervisorsettings.json new file mode 100644 index 00000000..75747631 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-bcdentryhypervisorsettings.json @@ -0,0 +1,210 @@ +{ + "name": "Get-BcdEntryHypervisorSettings", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-bcdstore.json b/command-signatures/json/autogenerated/powershell/get-bcdstore.json new file mode 100644 index 00000000..a3bbb083 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-bcdstore.json @@ -0,0 +1,210 @@ +{ + "name": "Get-BcdStore", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Path", + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill Path Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path", + "description": "{{ Fill Path Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-bitstransfer.json b/command-signatures/json/autogenerated/powershell/get-bitstransfer.json new file mode 100644 index 00000000..310b2cab --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-bitstransfer.json @@ -0,0 +1,218 @@ +{ + "name": "Get-BitsTransfer", + "options": [ + { + "name": [ + "-AllUsers", + "-all" + ], + "description": "Indicates that this cmdlet gets BITS transfer jobs that are owned by all users. If this parameter is not specified, only jobs that are owned by the current user are returned. This parameter requires administrative credentials." + }, + { + "name": [ + "-JobId", + "-id" + ], + "args": [ + { + "name": "Guid[]" + } + ], + "isRequired": true, + "description": "Specifies an array of BITS jobs by job ID. Only the BITS jobs that include a job ID in this array are returned. If BitsJob objects are piped to this cmdlet, their job IDs are used as the values of this parameter." + }, + { + "name": [ + "-Name", + "-n" + ], + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies an array of BITS jobs based on job name. Only BITS jobs with job names that match a name in this array are returned. You can use standard wildcard characters such as the asterisk (*) and the question mark (?). Or, you can use a range operator such as\"\\[a-r\\]\"." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-JobId-Or-Name" + } + ], + "description": "Gets the associated BitsJob object for an existing BITS transfer job.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-certificate.json b/command-signatures/json/autogenerated/powershell/get-certificate.json new file mode 100644 index 00000000..5d6d86d5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-certificate.json @@ -0,0 +1,261 @@ +{ + "name": "Get-Certificate", + "options": [ + { + "name": "-CertStoreLocation", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the path to the certificate store for the received certificate. If the request is made pending, then the request object is saved in the corresponding request store." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Credential", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.PkiCredential" + } + ], + "description": "Specifies the credential to use for certificate enrollment. The credential can be a user name and password (a credential object), an X509 certificate, or the path to a certificate. If a credential is not specified, then Kerberos authentication is used." + }, + { + "name": "-DnsName", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies one or more DNS names to be included in the certificate request as subject alternative name extension." + }, + { + "name": "-Request", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.Certificate" + } + ], + "isRequired": true, + "description": "Specifies the X509 certificate or the path to a requested certificate located in the request store." + }, + { + "name": "-SubjectName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the subject name to be included in the certificate request." + }, + { + "name": "-Template", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the object identifier or name of a certificate template to use with the certificate request." + }, + { + "name": "-Url", + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the policy server URL to use for certificate enrollment. Credentials are required if the endpoint requires a user name and password or certificate authentication from the client. If credentials are not found and Windows PowerShell is in interactive mode, then a prompt for credentials will appear." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Submits a certificate request to an enrollment server and installs the response or retrieves a certificate for a previously submitted request.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-certificateautoenrollmentpolicy.json b/command-signatures/json/autogenerated/powershell/get-certificateautoenrollmentpolicy.json new file mode 100644 index 00000000..a049fa43 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-certificateautoenrollmentpolicy.json @@ -0,0 +1,218 @@ +{ + "name": "Get-CertificateAutoEnrollmentPolicy", + "options": [ + { + "name": "-Scope", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.AutoEnrollmentPolicyScope", + "suggestions": [ + { + "name": "Applied" + }, + { + "name": "Local" + } + ] + } + ], + "isRequired": true, + "description": "Specifies the scope of the enrollment policy to return. If `Local` scope is specified, then the locally configured policy is returned. If `Applied` scope is specified, then the currently applied policy which can be either the local policy or a domain policy, is returned." + }, + { + "name": "-Context", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.Context", + "suggestions": [ + { + "name": "Machine" + }, + { + "name": "User" + } + ] + } + ], + "isRequired": true, + "description": "Specifies the context of the enrollment policy to return." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Retrieves certificate auto-enrollment policy settings.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-certificateenrollmentpolicyserver.json b/command-signatures/json/autogenerated/powershell/get-certificateenrollmentpolicyserver.json new file mode 100644 index 00000000..650a5d93 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-certificateenrollmentpolicyserver.json @@ -0,0 +1,230 @@ +{ + "name": "Get-CertificateEnrollmentPolicyServer", + "options": [ + { + "name": "-Scope", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.EnrollmentPolicyServerScope", + "suggestions": [ + { + "name": "Applied" + }, + { + "name": "ConfiguredByYou" + }, + { + "name": "All" + } + ] + } + ], + "isRequired": true, + "description": "Specifies where the cmdlet will find the enrollment policy server configuration." + }, + { + "name": "-Url", + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Limits the returned enrollment policy servers to the servers that contain the provided URL." + }, + { + "name": "-Context", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.Context", + "suggestions": [ + { + "name": "Machine" + }, + { + "name": "User" + } + ] + } + ], + "isRequired": true, + "description": "Retrieves information about the enrollment policy server for the local computer (machine) or current user context." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Returns all of the certificate enrollment policy server URL configurations.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-certificatenotificationtask.json b/command-signatures/json/autogenerated/powershell/get-certificatenotificationtask.json new file mode 100644 index 00000000..c40382d9 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-certificatenotificationtask.json @@ -0,0 +1,182 @@ +{ + "name": "Get-CertificateNotificationTask", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Returns all registered certificate notification tasks.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-childitem.json b/command-signatures/json/autogenerated/powershell/get-childitem.json index 120f2055..bdd57a84 100644 --- a/command-signatures/json/autogenerated/powershell/get-childitem.json +++ b/command-signatures/json/autogenerated/powershell/get-childitem.json @@ -28,6 +28,9 @@ { "name": "IntegrityStream" }, + { + "name": "None" + }, { "name": "Normal" }, @@ -58,11 +61,11 @@ ] } ], - "description": "Gets files and folders with the specified attributes. This parameter supports all attributes and lets you specify complex combinations of attributes.\n" + "description": "> [!NOTE] > This parameter is only available in the > [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider." }, { "name": "-CodeSigningCert", - "description": "To get a list of certificates that have `Code Signing` in their EnhancedKeyUsageList property value, use the CodeSigningCert parameter." + "description": "> [!NOTE] > This parameter is only available in the > [Certificate](../Microsoft.PowerShell.Security/About/about_Certificate_Provider.md) provider." }, { "name": "-Depth", @@ -71,14 +74,14 @@ "name": "System.UInt32" } ], - "description": "This parameter was added in PowerShell 5.0 and enables you to control the depth of recursion. By default, `Get-ChildItem` displays the contents of the parent directory. The Depth parameter determines the number of subdirectory levels that are included in the recursion and displays the contents.\n" + "description": "This parameter was added in PowerShell 5.0 and enables you to control the depth of recursion. By default, `Get-ChildItem` displays the contents of the parent directory. The Depth parameter determines the number of subdirectory levels that are included in the recursion and displays the contents." }, { "name": [ "-Directory", "-ad" ], - "description": "To get a list of directories, use the Directory parameter or the Attributes parameter with the Directory property. You can use the Recurse parameter with Directory ." + "description": "> [!NOTE] > This parameter is only available in the > [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider." }, { "name": "-DnsName", @@ -87,11 +90,11 @@ "name": "Microsoft.PowerShell.Commands.DnsNameRepresentation" } ], - "description": "Specifies a domain name or name pattern to match with the DNSNameList property of certificates the cmdlet gets. The value of this parameter can either be `Unicode` or `ASCII`. Punycode values are converted to Unicode. Wildcard characters (`*`) are permitted.\n" + "description": "> [!NOTE] > This parameter is only available in the > [Certificate](../Microsoft.PowerShell.Security/About/about_Certificate_Provider.md) provider." }, { "name": "-DocumentEncryptionCert", - "description": "To get a list of certificates that have `Document Encryption` in their EnhancedKeyUsageList property value, use the DocumentEncryptionCert parameter." + "description": "> [!NOTE] > This parameter is only available in the > [Certificate](../Microsoft.PowerShell.Security/About/about_Certificate_Provider.md) provider." }, { "name": "-Eku", @@ -100,7 +103,7 @@ "name": "System.String" } ], - "description": "Specifies text or a text pattern to match with the EnhancedKeyUsageList property of certificates the cmdlet gets. Wildcard characters (` `) are permitted. The EnhancedKeyUsageList * property contains the friendly name and the OID fields of the EKU.\n" + "description": "> [!NOTE] > This parameter is only available in the > [Certificate](../Microsoft.PowerShell.Security/About/about_Certificate_Provider.md) provider." }, { "name": "-Exclude", @@ -109,7 +112,7 @@ "name": "System.String[]" } ], - "description": "Specifies an array of one or more string patterns to be matched as the cmdlet gets child items. Any matching item is excluded from the output. Enter a path element or pattern, such as ` .txt` or `A `. Wildcard characters are accepted.\n" + "description": "Specifies an array of one or more string patterns to be matched as the cmdlet gets child items. Any matching item is excluded from the output. Enter a path element or pattern, such as `*.txt` or `A*`. Wildcard characters are accepted." }, { "name": "-ExpiringInDays", @@ -118,14 +121,14 @@ "name": "System.Int32" } ], - "description": "Specifies that the cmdlet should only return certificates that are expiring in or before the specified number of days. A value of zero (`0`) gets certificates that have expired.\n" + "description": "> [!NOTE] > This parameter is only available in the > [Certificate](../Microsoft.PowerShell.Security/About/about_Certificate_Provider.md) provider." }, { "name": [ "-File", "-af" ], - "description": "To get a list of files, use the File parameter. You can use the Recurse parameter with File ." + "description": "> [!NOTE] > This parameter is only available in the > [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider." }, { "name": "-Filter", @@ -134,15 +137,15 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports filters. Filters are more efficient than other parameters. The provider applies filter when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved. The filter string is passed to the .NET API to enumerate files. The API only supports `*` and `?` wildcards." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports filters. Filters are more efficient than other parameters. The provider applies filter when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved. The filter string is passed to the .NET API to enumerate files. The API only supports `*` and `?` wildcards." }, { "name": "-FollowSymlink", - "description": "By default, the `Get-ChildItem` cmdlet displays symbolic links to directories found during recursion, but doesn't recurse into them. Use the FollowSymlink parameter to search the directories that target those symbolic links. The FollowSymlink is a dynamic parameter and is supported only in the FileSystem provider.\n" + "description": "> [!NOTE] > This parameter is only available in the > [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider." }, { "name": "-Force", - "description": "Allows the cmdlet to get items that otherwise can't be accessed by the user, such as hidden or system files. The Force parameter doesn't override security restrictions. Implementation varies among providers. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md)." + "description": "Allows the cmdlet to get items that otherwise can't be accessed by the user, such as hidden or system files. The Force parameter doesn't override security restrictions. Implementation varies by provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md)." }, { "name": [ @@ -150,7 +153,7 @@ "-ah", "-h" ], - "description": "To get only hidden items, use the Hidden parameter or the Attributes parameter with the Hidden property. By default, `Get-ChildItem` doesn't display hidden items. Use the Force parameter to get hidden items." + "description": "> [!NOTE] > This parameter is only available in the > [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider." }, { "name": "-Include", @@ -159,7 +162,7 @@ "name": "System.String[]" } ], - "description": "Specifies an array of one or more string patterns to be matched as the cmdlet gets child items. Any matching item is included in the output. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory.\n" + "description": "Specifies an array of one or more string patterns to be matched as the cmdlet gets child items. Any matching item is included in the output. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -173,7 +176,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell to not interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell to not interpret any characters as escape sequences." }, { "name": "-Name", @@ -183,36 +186,36 @@ "name": "-Path", "args": [ { - "name": "System.String[]", - "default": "Current directory" + "name": "System.String[]" } ], - "description": "Specifies a path to one or more locations. Wildcards are accepted. The default location is the current directory (`.`)." + "description": "Specifies a path to one or more locations. If not specified, the default location is the current directory (`.`). Wildcards are accepted. Use care when using the Path parameter with the Recurse parameter. For more information, see the [NOTES](#notes) section of this article." }, { "name": [ "-ReadOnly", "-ar" ], - "description": "To get only read-only items, use the ReadOnly parameter or the Attributes parameter ReadOnly property." + "description": "> [!NOTE] > This parameter is only available in the > [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider." }, { "name": [ "-Recurse", - "-s" + "-s", + "-r" ], "description": "Gets the items in the specified locations and in all child items of the locations." }, { "name": "-SSLServerAuthentication", - "description": "To get a list of certificates that have `Server Authentication` in their EnhancedKeyUsageList property value, use the SSLServerAuthentication parameter." + "description": "> [!NOTE] > This parameter is only available in the > [Certificate](../Microsoft.PowerShell.Security/About/about_Certificate_Provider.md) provider." }, { "name": [ "-System", "-as" ], - "description": "Gets only system files and directories. To get only system files and folders, use the System parameter or Attributes parameter System property." + "description": "> [!NOTE] > This parameter is only available in the > [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider." }, { "name": [ @@ -388,11 +391,11 @@ "args": [ { "name": "-Path", - "description": "Specifies a path to one or more locations. Wildcards are accepted. The default location is the current directory (`.`)." + "description": "Specifies a path to one or more locations. If not specified, the default location is the current directory (`.`). Wildcards are accepted. Use care when using the Path parameter with the Recurse parameter. For more information, see the [NOTES](#notes) section of this article." }, { "name": "-Filter", - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports filters. Filters are more efficient than other parameters. The provider applies filter when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved. The filter string is passed to the .NET API to enumerate files. The API only supports `*` and `?` wildcards." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports filters. Filters are more efficient than other parameters. The provider applies filter when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved. The filter string is passed to the .NET API to enumerate files. The API only supports `*` and `?` wildcards." } ], "description": "Gets the items and child items in one or more specified locations.", diff --git a/command-signatures/json/autogenerated/powershell/get-cimassociatedinstance.json b/command-signatures/json/autogenerated/powershell/get-cimassociatedinstance.json new file mode 100644 index 00000000..69babac8 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-cimassociatedinstance.json @@ -0,0 +1,279 @@ +{ + "name": "Get-CimAssociatedInstance", + "options": [ + { + "name": "-Association", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the association class. If you don't specify this parameter, the cmdlet returns all existing association objects of any type." + }, + { + "name": "-CimSession", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimSession[]" + } + ], + "isRequired": true, + "description": "Runs the command using the specified CIM session. Enter a variable that contains the CIM session, or a command that creates or gets the CIM session, such as `New-CimSession` or `Get-CimSession`. For more information, see [about_CimSession](../Microsoft.PowerShell.Core/About/about_CimSession.md)." + }, + { + "name": [ + "-ComputerName", + "-CN", + "-ServerName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the name of the computer on which you want to run the CIM operation. You can specify a fully qualified domain name (FQDN) or a NetBIOS name." + }, + { + "name": [ + "-InputObject", + "-CimInstance" + ], + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimInstance" + } + ], + "isRequired": true, + "description": "Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet." + }, + { + "name": "-KeyOnly", + "description": "Returns objects with only key properties populated. This reduces the amount of data that's transferred over the network." + }, + { + "name": "-Namespace", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the namespace for the CIM operation. The default namespace is root/CIMV2." + }, + { + "name": [ + "-OperationTimeoutSec", + "-OT" + ], + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "Specifies the amount of time that the cmdlet waits for a response from the computer. By default, the value of this parameter is 0, which means that the cmdlet uses the default timeout value for the server." + }, + { + "name": "-ResourceUri", + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the resource uniform resource identifier (URI) of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": "-ResultClassName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the class name of the associated instances. A CIM instance can be associated with one or more CIM instances. All associated CIM instances are returned if you don't specify the result class name." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject", + "description": "Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet." + }, + { + "name": "-Association", + "description": "Specifies the name of the association class. If you don't specify this parameter, the cmdlet returns all existing association objects of any type." + } + ], + "description": "Retrieves the CIM instances that are connected to a specific CIM instance by an association.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-cimclass.json b/command-signatures/json/autogenerated/powershell/get-cimclass.json new file mode 100644 index 00000000..923e4581 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-cimclass.json @@ -0,0 +1,275 @@ +{ + "name": "Get-CimClass", + "options": [ + { + "name": "-Amended", + "description": "Indicates that objects returned from the CIM query should contain amended information. Typically, amended information is localizable information, such as object and property descriptions that are attached to the CIM object. This is useful for translating numeric values to human-readable values." + }, + { + "name": "-CimSession", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimSession[]" + } + ], + "isRequired": true, + "description": "Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a `New-CimSession` or `Get-CimSession` cmdlet. The default is the current session on the local computer." + }, + { + "name": "-ClassName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the CIM class for which to perform the operation. You can use tab completion to browse the list of classes, because PowerShell gets a list of classes from the local WMI server to provide a list of class names." + }, + { + "name": [ + "-ComputerName", + "-CN", + "-ServerName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the computer on which you want to run the CIM operation. You can specify a fully qualified domain name (FQDN) a NetBIOS name, or an IP address." + }, + { + "name": "-MethodName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Finds the classes that have a method matching this name. You can use wildcard characters with this parameter." + }, + { + "name": "-Namespace", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the namespace for CIM operation. The default namespace is root/CIMV2. You can use tab completion to browse the list of namespaces, because PowerShell gets a list of namespaces from the local WMI server to provide the list of namespaces." + }, + { + "name": [ + "-OperationTimeoutSec", + "-OT" + ], + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "Specifies the amount of time that the cmdlet waits for a response from the computer. By default, the value of this parameter is 0, which means that the cmdlet uses the default timeout value for the server." + }, + { + "name": "-PropertyName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Finds the classes which have a property matching this name. You can use wildcard characters with this parameter." + }, + { + "name": "-QualifierName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Filters the classes by class level qualifier name. You can use wildcard characters with this parameter." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ClassName", + "description": "Specifies the name of the CIM class for which to perform the operation. You can use tab completion to browse the list of classes, because PowerShell gets a list of classes from the local WMI server to provide a list of class names." + }, + { + "name": "-Namespace", + "description": "Specifies the namespace for CIM operation. The default namespace is root/CIMV2. You can use tab completion to browse the list of namespaces, because PowerShell gets a list of namespaces from the local WMI server to provide the list of namespaces." + } + ], + "description": "Gets a list of CIM classes in a specific namespace.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-ciminstance.json b/command-signatures/json/autogenerated/powershell/get-ciminstance.json new file mode 100644 index 00000000..89b21d12 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-ciminstance.json @@ -0,0 +1,311 @@ +{ + "name": "Get-CimInstance", + "options": [ + { + "name": "-CimSession", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimSession[]" + } + ], + "isRequired": true, + "description": "Specifies the CIM session to use for this cmdlet. Enter a variable that contains the CIM session or a command that creates or gets the CIM session, such as the `New-CimSession` or `Get-CimSession` cmdlets. For more information, see [about_CimSession](../Microsoft.PowerShell.Core/About/about_CimSession.md)." + }, + { + "name": "-ClassName", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the CIM class for which to retrieve the CIM instances. You can use tab completion to browse the list of classes, because PowerShell gets a list of classes from the local WMI server to provide a list of class names." + }, + { + "name": [ + "-ComputerName", + "-CN", + "-ServerName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies computer on which you want to run the CIM operation. You can specify a fully qualified domain name (FQDN), a NetBIOS name, or an IP address. If you do not specify this parameter, the cmdlet performs the operation on the local computer using Component Object Model (COM)." + }, + { + "name": "-Filter", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a where clause to use as a filter. Specify the clause in either the WQL or the CQL query language. Do not include the `WHERE` keyword in the value of the parameter." + }, + { + "name": [ + "-InputObject", + "-CimInstance" + ], + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimInstance" + } + ], + "isRequired": true, + "description": "Specifies a CIM instance object to use as input." + }, + { + "name": "-KeyOnly", + "description": "Indicates that only objects with key properties populated are returned. Specifying the KeyOnly parameter reduces the amount of data transferred over the network." + }, + { + "name": "-Namespace", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the namespace of CIM class." + }, + { + "name": [ + "-OperationTimeoutSec", + "-OT" + ], + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "Specifies the amount of time that the cmdlet waits for a response from the computer. By default, the value of this parameter is 0, which means that the cmdlet uses the default timeout value for the server." + }, + { + "name": [ + "-Property", + "-SelectProperties" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies a set of instance properties to retrieve. Use this parameter when you need to reduce the size of the object returned, either in memory or over the network. The object returned also contains the key properties even if you have not listed them using the Property parameter. Other properties of the class are present but they are not populated." + }, + { + "name": "-Query", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies a query to run on the CIM server. If the value specified contains double quotes `\"`, single quotes `'`, or a backslash `\\`, you must escape those characters by prefixing them with the backslash character. If the value specified uses the WQL LIKE operator, then you must escape the following characters by enclosing them in square brackets `[]`: percent `%`, underscore `_`, or opening square bracket `[`." + }, + { + "name": "-QueryDialect", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the query language used for the Query parameter. The acceptable values for this parameter are: WQL or CQL. The default value is WQL." + }, + { + "name": "-ResourceUri", + "args": [ + { + "name": "System.Uri" + } + ], + "isRequired": true, + "description": "Specifies the resource uniform resource identifier (URI) of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": "-Shallow", + "description": "Indicates that the instances of a class are returned without including the instances of any child classes. By default, the cmdlet returns the instances of a class and its child classes." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ClassName-Or-InputObject" + } + ], + "description": "Gets the CIM instances of a class from a CIM server.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-cimsession.json b/command-signatures/json/autogenerated/powershell/get-cimsession.json new file mode 100644 index 00000000..b2e0c85b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-cimsession.json @@ -0,0 +1,229 @@ +{ + "name": "Get-CimSession", + "options": [ + { + "name": [ + "-ComputerName", + "-CN", + "-ServerName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the name of the computer to get CIM sessions connected to. Wildcard characters are permitted." + }, + { + "name": "-Id", + "args": [ + { + "name": "System.UInt32[]" + } + ], + "isRequired": true, + "description": "Specifies the identifier of the CIM session to get. For multiple IDs, use commas to separate the IDs or use the range operator (`..`) to specify a range of IDs. An Id is an integer that uniquely identifies the CIM session within the current PowerShell session." + }, + { + "name": "-InstanceId", + "args": [ + { + "name": "System.Guid[]" + } + ], + "isRequired": true, + "description": "Specifies the instance IDs of the CIM session to get." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Gets one or more CIM sessions which contain the specified friendly names. Wildcard characters are permitted." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ComputerName-Or-Id" + } + ], + "description": "Gets the CIM session objects from the current session.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-cmsmessage.json b/command-signatures/json/autogenerated/powershell/get-cmsmessage.json index 5c42b98d..a9750666 100644 --- a/command-signatures/json/autogenerated/powershell/get-cmsmessage.json +++ b/command-signatures/json/autogenerated/powershell/get-cmsmessage.json @@ -19,7 +19,7 @@ } ], "isRequired": true, - "description": "Specifies the path to encrypted content that you want to get. Unlike Path , the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose each one in single quotation marks. Single quotation marks tell PowerShell not to interpret enclosed characters as escape characters." + "description": "Specifies the path to encrypted content that you want to get. Unlike Path, the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose each one in single quotation marks. Single quotation marks tell PowerShell not to interpret enclosed characters as escape characters." }, { "name": "-Path", diff --git a/command-signatures/json/autogenerated/powershell/get-command.json b/command-signatures/json/autogenerated/powershell/get-command.json index a8ca80e9..265a54c8 100644 --- a/command-signatures/json/autogenerated/powershell/get-command.json +++ b/command-signatures/json/autogenerated/powershell/get-command.json @@ -3,7 +3,7 @@ "options": [ { "name": "-All", - "description": "Indicates that this cmdlet gets all commands, including commands of the same type that have the same name. By default, `Get-Command` gets only the commands that run when you type the command name.\n" + "description": "Indicates that this cmdlet gets all commands, including commands of the same type that have the same name. By default, `Get-Command` gets only the commands that run when you type the command name." }, { "name": [ @@ -15,7 +15,7 @@ "name": "System.Object[]" } ], - "description": "Specifies an array of arguments. This cmdlet gets information about a cmdlet or function when it is used with the specified parameters (\"arguments\"). The alias for ArgumentList is Args .\n" + "description": "Specifies an array of arguments. This cmdlet gets information about a cmdlet or function when it's used with the specified parameters (\"arguments\"). The alias for ArgumentList is Args." }, { "name": [ @@ -30,36 +30,33 @@ "name": "Alias" }, { - "name": "Function" + "name": "All" }, { - "name": "Filter" + "name": "Application" }, { "name": "Cmdlet" }, { - "name": "ExternalScript" - }, - { - "name": "Application" + "name": "Configuration" }, { - "name": "Script" + "name": "ExternalScript" }, { - "name": "Workflow" + "name": "Filter" }, { - "name": "Configuration" + "name": "Function" }, { - "name": "All" + "name": "Script" } ] } ], - "description": "Specifies the types of commands that this cmdlet gets. Enter one or more command types. Use CommandType or its alias, Type . By default, `Get-Command` gets all cmdlets, functions, and aliases.\n" + "description": "Specifies the types of commands that this cmdlet gets. Enter one or more command types. Use CommandType or its alias, Type. By default, `Get-Command` gets all cmdlets, functions, and aliases." }, { "name": "-FullyQualifiedModule", @@ -68,11 +65,20 @@ "name": "Microsoft.PowerShell.Commands.ModuleSpecification[]" } ], - "description": "The value can be a module name, a full module specification, or a path to a module file.\n" + "description": "The value can be a module name or a full module specification. PowerShell searches the PSModulePath for the specified module." + }, + { + "name": "-FuzzyMinimumDistance", + "args": [ + { + "name": "UInt32" + } + ], + "description": "This parameter allows filtering fuzzy results to be more or less accurate. The distance is calculated using the Damerau Levenshtein Distance algorithm, which indicates how many steps is the match from the original value. A lower distance is more accurate. A distance of zero is an exact match." }, { "name": "-ListImported", - "description": "Indicates that this cmdlet gets only commands in the current session.\n" + "description": "Indicates that this cmdlet gets only commands in the current session." }, { "name": [ @@ -84,7 +90,7 @@ "name": "System.String[]" } ], - "description": "Specifies an array of modules. This cmdlet gets the commands that came from the specified modules. Enter the names of modules or module objects.\n" + "description": "Specifies an array of modules. This cmdlet gets the commands that came from the specified modules. Enter the names of modules or module objects." }, { "name": "-Name", @@ -93,7 +99,7 @@ "name": "System.String[]" } ], - "description": "Specifies an array of names. This cmdlet gets only commands that have the specified name. Enter a name or name pattern. Wildcard characters are permitted.\n" + "description": "Specifies an array of names. This cmdlet gets only commands that have the specified name. Enter a name or name pattern. Wildcard characters are permitted." }, { "name": "-Noun", @@ -111,7 +117,7 @@ "name": "System.String[]" } ], - "description": "Specifies an array of parameter names. This cmdlet gets commands in the session that have the specified parameters. Enter parameter names or parameter aliases. Wildcard characters are supported.\n" + "description": "Specifies an array of parameter names. This cmdlet gets commands in the session that have the specified parameters. Enter parameter names or parameter aliases. Wildcard characters are supported." }, { "name": "-ParameterType", @@ -120,15 +126,15 @@ "name": "System.Management.Automation.PSTypeName[]" } ], - "description": "Specifies an array of parameter names. This cmdlet gets commands in the session that have parameters of the specified type. Enter the full name or partial name of a parameter type. Wildcard characters are supported.\n" + "description": "Specifies an array of parameter names. This cmdlet gets commands in the session that have parameters of the specified type. Enter the full name or partial name of a parameter type. Wildcard characters are supported." }, { "name": "-ShowCommandInfo", - "description": "Indicates that this cmdlet displays command information.\n" + "description": "Indicates that this cmdlet displays command information." }, { "name": "-Syntax", - "description": "Indicates that this cmdlet gets only the following specified data about the command:\n" + "description": "Indicates that this cmdlet gets only the following specified data about the command:" }, { "name": "-TotalCount", @@ -145,7 +151,7 @@ }, { "name": "-UseFuzzyMatching", - "description": "Indicates using a fuzzy matching algorithm when finding commands. The order of the output is from closest match to least likely match. Wildcards should not be used with fuzzy matching as it will attempt to match commands that may contain those wildcard characters." + "description": "Indicates using a fuzzy matching algorithm when finding commands. The order of the output is from closest match to least likely match. Wildcards shouldn't be used with fuzzy matching as it will attempt to match commands that may contain those wildcard characters." }, { "name": "-Verb", @@ -330,11 +336,11 @@ "args": [ { "name": "-Name", - "description": "Specifies an array of names. This cmdlet gets only commands that have the specified name. Enter a name or name pattern. Wildcard characters are permitted.\n" + "description": "Specifies an array of names. This cmdlet gets only commands that have the specified name. Enter a name or name pattern. Wildcard characters are permitted." }, { "name": "-ArgumentList", - "description": "Specifies an array of arguments. This cmdlet gets information about a cmdlet or function when it is used with the specified parameters (\"arguments\"). The alias for ArgumentList is Args .\n" + "description": "Specifies an array of arguments. This cmdlet gets information about a cmdlet or function when it's used with the specified parameters (\"arguments\"). The alias for ArgumentList is Args." } ], "description": "Gets all commands.", diff --git a/command-signatures/json/autogenerated/powershell/get-computerinfo.json b/command-signatures/json/autogenerated/powershell/get-computerinfo.json new file mode 100644 index 00000000..5d9ee808 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-computerinfo.json @@ -0,0 +1,196 @@ +{ + "name": "Get-ComputerInfo", + "options": [ + { + "name": "-Property", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies, as a string array, the computer properties in which this cmdlet displays." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Property", + "description": "Specifies, as a string array, the computer properties in which this cmdlet displays." + } + ], + "description": "Gets a consolidated object of system and operating system properties.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-computerrestorepoint.json b/command-signatures/json/autogenerated/powershell/get-computerrestorepoint.json new file mode 100644 index 00000000..5f9fee8c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-computerrestorepoint.json @@ -0,0 +1,198 @@ +{ + "name": "Get-ComputerRestorePoint", + "options": [ + { + "name": "-LastStatus", + "isRequired": true + }, + { + "name": "-RestorePoint", + "args": [ + { + "name": "int[]" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-RestorePoint" + } + ], + "description": "Get-ComputerRestorePoint [[-RestorePoint] ] [] Get-ComputerRestorePoint -LastStatus []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-content.json b/command-signatures/json/autogenerated/powershell/get-content.json index f2ea5cc6..8947aaf4 100644 --- a/command-signatures/json/autogenerated/powershell/get-content.json +++ b/command-signatures/json/autogenerated/powershell/get-content.json @@ -3,26 +3,25 @@ "options": [ { "name": "-AsByteStream", - "description": "Specifies that the content should be read as a stream of bytes. The AsByteStream parameter was introduced in Windows PowerShell 6.0.\n" + "description": "Specifies that the content should be read as a stream of bytes. The AsByteStream parameter was introduced in Windows PowerShell 6.0." }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter isn't supported by any providers installed with PowerShell. To impersonate another > user, or elevate your credentials when running this cmdlet, use > [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Delimiter", "args": [ { - "name": "System.String", - "default": "End-of-line character" + "name": "System.String" } ], - "description": "Specifies the delimiter that `Get-Content` uses to divide the file into objects while it reads. The default is `\\n`, the end-of-line character. When reading a text file, `Get-Content` returns a collection of string objects, each ending with an end-of-line character. When you enter a delimiter that doesn't exist in the file, `Get-Content` returns the entire file as a single, undelimited object.\n" + "description": "Specifies the delimiter that `Get-Content` uses to divide the file into objects while it reads. The default is `\\n`, the end-of-line character. When reading a text file, `Get-Content` returns a collection of string objects, each ending with an end-of-line character. When you enter a delimiter that doesn't exist in the file, `Get-Content` returns the entire file as a single, undelimited object." }, { "name": "-Encoding", @@ -31,40 +30,42 @@ "name": "System.Text.Encoding", "suggestions": [ { - "name": "ASCII" + "name": "ansi" + }, + { + "name": "ascii" }, { - "name": "BigEndianUnicode" + "name": "bigendianunicode" }, { - "name": "BigEndianUTF32" + "name": "bigendianutf32" }, { - "name": "OEM" + "name": "oem" }, { - "name": "Unicode" + "name": "unicode" }, { - "name": "UTF7" + "name": "utf32" }, { - "name": "UTF8" + "name": "utf7" }, { - "name": "UTF8BOM" + "name": "utf8" }, { - "name": "UTF8NoBOM" + "name": "utf8BOM" }, { - "name": "UTF32" + "name": "utf8NoBOM" } - ], - "default": "UTF8NoBOM" + ] } ], - "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`.\n" + "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`." }, { "name": "-Exclude", @@ -73,7 +74,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter.\n" + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter." }, { "name": "-Filter", @@ -82,7 +83,7 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved." }, { "name": "-Force", @@ -95,7 +96,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -109,7 +110,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Path", @@ -123,17 +124,16 @@ }, { "name": "-Raw", - "description": "Ignores newline characters and returns the entire contents of a file in one string with the newlines preserved. By default, newline characters in a file are used as delimiters to separate the input into an array of strings. This parameter was introduced in PowerShell 3.0. Raw is a dynamic parameter that the FileSystem provider adds to the `Get-Content` cmdlet This parameter works only in file system drives." + "description": "Ignores newline characters and returns the entire contents of a file in one string with the newlines preserved. By default, newline characters in a file are used as delimiters to separate the input into an array of strings. This parameter was introduced in PowerShell 3.0." }, { "name": "-ReadCount", "args": [ { - "name": "System.Int64", - "default": "1" + "name": "System.Int64" } ], - "description": "Specifies how many lines of content are sent through the pipeline at a time. The default value is 1. A value of 0 (zero) or negative numbers sends all the content at one time.\n" + "description": "Specifies how many lines of content are sent through the pipeline at a time. The default value is 1. A value of 0 (zero) or negative numbers sends all the content at one time." }, { "name": "-Stream", @@ -142,7 +142,7 @@ "name": "System.String" } ], - "description": "Gets the contents of the specified alternate NTFS file stream from the file. Enter the stream name. Wildcards aren't supported. Stream is a dynamic parameter that the FileSystem provider adds to the `Get-Content` cmdlet. This parameter works only in file system drives on Windows systems.\n" + "description": "> [!NOTE] > This Parameter is only available on Windows." }, { "name": [ @@ -154,7 +154,7 @@ "name": "System.Int32" } ], - "description": "Specifies the number of lines from the end of a file or other item. You can use the Tail parameter name or its alias, Last . Negative values cause the cmdlet to return the entire contents.\n" + "description": "Specifies the number of lines from the end of a file or other item. You can use the Tail parameter name or its alias, Last. A value of `0` returns no lines. Negative values cause an error." }, { "name": [ @@ -167,11 +167,11 @@ "name": "System.Int64" } ], - "description": "Specifies the number of lines from the beginning of a file or other item. Negative values cause the cmdlet to return the entire contents.\n" + "description": "Specifies the number of lines from the beginning of a file or other item. A value of `0` returns no lines. Negative values cause an error." }, { "name": "-Wait", - "description": "Causes the cmdlet to wait indefinitely, keeping the file open, until interrupted. While waiting, `Get-Content` checks the file once per second and outputs new lines if present. When used with the TotalCount parameter, `Get-Content` waits until the specified number of lines are available in the specified file. For example, if you specify a TotalCount of 10 and the file already has 10 or more lines, `Get-Content` returns the 10 lines and exits. If the file has fewer than 10 lines, `Get-Content` outputs each line as it arrives, but waits until the tenth line arrives before exiting.\n" + "description": "Causes the cmdlet to wait indefinitely, keeping the file open, until interrupted. While waiting, `Get-Content` checks the file once per second and outputs new lines if present. When used with the TotalCount parameter, `Get-Content` waits until the specified number of lines are available in the specified file. For example, if you specify a TotalCount of 10 and the file already has 10 or more lines, `Get-Content` returns the 10 lines and exits. If the file has fewer than 10 lines, `Get-Content` outputs each line as it arrives, but waits until the tenth line arrives before exiting." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/get-controlpanelitem.json b/command-signatures/json/autogenerated/powershell/get-controlpanelitem.json new file mode 100644 index 00000000..879dec7b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-controlpanelitem.json @@ -0,0 +1,211 @@ +{ + "name": "Get-ControlPanelItem", + "options": [ + { + "name": "-CanonicalName", + "args": [ + { + "name": "string[]" + } + ], + "isRequired": true + }, + { + "name": "-Category", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-Name", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name" + } + ], + "description": "Get-ControlPanelItem [[-Name] ] [-Category ] [] Get-ControlPanelItem -CanonicalName [-Category ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-counter.json b/command-signatures/json/autogenerated/powershell/get-counter.json new file mode 100644 index 00000000..0583b0ac --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-counter.json @@ -0,0 +1,239 @@ +{ + "name": "Get-Counter", + "options": [ + { + "name": [ + "-ComputerName", + "-Cn" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies one computer name or a comma-separated array of remote computer names. Use the NetBIOS name, an IP address, or the computer's fully qualified domain name." + }, + { + "name": "-Continuous", + "description": "When Continuous is specified, `Get-Counter` gets samples until you press CTRL+C. Samples are obtained every second for each specified performance counter. Use the SampleInterval parameter to increase the interval between continuous samples." + }, + { + "name": "-Counter", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the path to one or more counter paths. Paths are input as a comma-separated array, a variable, or values from a text file. You can send counter path strings down the pipeline to `Get-Counter`." + }, + { + "name": "-ListSet", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Lists the performance counter sets on the computers. Use an asterisk (`*`) to specify all counter sets. Enter one name or a comma-separated string of counter set names. You can send counter set names down the pipeline." + }, + { + "name": "-MaxSamples", + "args": [ + { + "name": "System.Int64" + } + ], + "description": "Specifies the number of samples to get from each specified performance counter. To get a constant stream of samples, use the Continuous parameter." + }, + { + "name": "-SampleInterval", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies the number of seconds between samples for each specified performance counter. If the SampleInterval parameter isn't specified, `Get-Counter` uses a one-second interval." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Counter-Or-ListSet" + } + ], + "description": "Gets performance counter data from local and remote computers.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-credential.json b/command-signatures/json/autogenerated/powershell/get-credential.json index b1cf30a3..aa326f9e 100644 --- a/command-signatures/json/autogenerated/powershell/get-credential.json +++ b/command-signatures/json/autogenerated/powershell/get-credential.json @@ -8,7 +8,7 @@ "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user name for the credential, such as User01 or Domain01\\User01 . The parameter name, `-Credential`, is optional.\n" + "description": "Specifies a user name for the credential, such as User01 or Domain01\\User01. The parameter name, `-Credential`, is optional." }, { "name": "-Message", @@ -17,7 +17,7 @@ "name": "System.String" } ], - "description": "Specifies a message that appears in the authentication prompt. This parameter is designed for use in a function or script. You can use the message to explain to the user why you are requesting credentials and how they will be used.\n" + "description": "Specifies a message that appears in the authentication prompt. This parameter is designed for use in a function or script. You can use the message to explain to the user why you are requesting credentials and how they will be used." }, { "name": "-Title", @@ -26,17 +26,16 @@ "name": "System.String" } ], - "description": "Sets the text of the title line for the authentication prompt in the console.\n" + "description": "Sets the text of the title line for the authentication prompt in the console." }, { "name": "-UserName", "args": [ { - "name": "System.String", - "default": "None (blank)" + "name": "System.String" } ], - "description": "Specifies a user name. The authentication prompt requests a password for the user name. By default, the user name is blank and the authentication prompt requests both a user name and password.\n" + "description": "Specifies a user name. The authentication prompt requests a password for the user name. By default, the user name is blank and the authentication prompt requests both a user name and password." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/get-culture.json b/command-signatures/json/autogenerated/powershell/get-culture.json index b76cbf67..2b5ac09d 100644 --- a/command-signatures/json/autogenerated/powershell/get-culture.json +++ b/command-signatures/json/autogenerated/powershell/get-culture.json @@ -3,20 +3,2689 @@ "options": [ { "name": "-ListAvailable", - "description": "Retrieves all cultures supported by the current operating system.\n" + "description": "Retrieves all cultures supported by the current operating system." }, { "name": "-Name", "args": [ { - "name": "System.String[]" + "name": "System.String[]", + "suggestions": [ + { + "name": "aa" + }, + { + "name": "aa-DJ" + }, + { + "name": "aa-ER" + }, + { + "name": "aa-ET" + }, + { + "name": "af" + }, + { + "name": "af-NA" + }, + { + "name": "af-ZA" + }, + { + "name": "agq" + }, + { + "name": "agq-CM" + }, + { + "name": "ak" + }, + { + "name": "ak-GH" + }, + { + "name": "am" + }, + { + "name": "am-ET" + }, + { + "name": "ar" + }, + { + "name": "ar-001" + }, + { + "name": "ar-AE" + }, + { + "name": "ar-BH" + }, + { + "name": "ar-DJ" + }, + { + "name": "ar-DZ" + }, + { + "name": "ar-EG" + }, + { + "name": "ar-ER" + }, + { + "name": "ar-IL" + }, + { + "name": "ar-IQ" + }, + { + "name": "ar-JO" + }, + { + "name": "ar-KM" + }, + { + "name": "ar-KW" + }, + { + "name": "ar-LB" + }, + { + "name": "ar-LY" + }, + { + "name": "ar-MA" + }, + { + "name": "ar-MR" + }, + { + "name": "ar-OM" + }, + { + "name": "ar-PS" + }, + { + "name": "ar-QA" + }, + { + "name": "ar-SA" + }, + { + "name": "ar-SD" + }, + { + "name": "ar-SO" + }, + { + "name": "ar-SS" + }, + { + "name": "ar-SY" + }, + { + "name": "ar-TD" + }, + { + "name": "ar-TN" + }, + { + "name": "ar-YE" + }, + { + "name": "arn" + }, + { + "name": "arn-CL" + }, + { + "name": "as" + }, + { + "name": "as-IN" + }, + { + "name": "asa" + }, + { + "name": "asa-TZ" + }, + { + "name": "ast" + }, + { + "name": "ast-ES" + }, + { + "name": "az" + }, + { + "name": "az-Cyrl" + }, + { + "name": "az-Cyrl-AZ" + }, + { + "name": "az-Latn" + }, + { + "name": "az-Latn-AZ" + }, + { + "name": "ba" + }, + { + "name": "ba-RU" + }, + { + "name": "bas" + }, + { + "name": "bas-CM" + }, + { + "name": "be" + }, + { + "name": "be-BY" + }, + { + "name": "bem" + }, + { + "name": "bem-ZM" + }, + { + "name": "bez" + }, + { + "name": "bez-TZ" + }, + { + "name": "bg" + }, + { + "name": "bg-BG" + }, + { + "name": "bgc" + }, + { + "name": "bgc-IN" + }, + { + "name": "bho" + }, + { + "name": "bho-IN" + }, + { + "name": "bin" + }, + { + "name": "bin-NG" + }, + { + "name": "bm" + }, + { + "name": "bm-ML" + }, + { + "name": "bn" + }, + { + "name": "bn-BD" + }, + { + "name": "bn-IN" + }, + { + "name": "bo" + }, + { + "name": "bo-CN" + }, + { + "name": "bo-IN" + }, + { + "name": "br" + }, + { + "name": "br-FR" + }, + { + "name": "brx" + }, + { + "name": "brx-IN" + }, + { + "name": "bs" + }, + { + "name": "bs-Cyrl" + }, + { + "name": "bs-Cyrl-BA" + }, + { + "name": "bs-Latn" + }, + { + "name": "bs-Latn-BA" + }, + { + "name": "byn" + }, + { + "name": "byn-ER" + }, + { + "name": "ca" + }, + { + "name": "ca-AD" + }, + { + "name": "ca-ES" + }, + { + "name": "ca-FR" + }, + { + "name": "ca-IT" + }, + { + "name": "ccp" + }, + { + "name": "ccp-BD" + }, + { + "name": "ccp-IN" + }, + { + "name": "ce" + }, + { + "name": "ce-RU" + }, + { + "name": "ceb" + }, + { + "name": "ceb-PH" + }, + { + "name": "cgg" + }, + { + "name": "cgg-UG" + }, + { + "name": "chr" + }, + { + "name": "chr-US" + }, + { + "name": "ckb" + }, + { + "name": "ckb-IQ" + }, + { + "name": "ckb-IR" + }, + { + "name": "co" + }, + { + "name": "co-FR" + }, + { + "name": "cs" + }, + { + "name": "cs-CZ" + }, + { + "name": "cu" + }, + { + "name": "cu-RU" + }, + { + "name": "cv" + }, + { + "name": "cv-RU" + }, + { + "name": "cy" + }, + { + "name": "cy-GB" + }, + { + "name": "da" + }, + { + "name": "da-DK" + }, + { + "name": "da-GL" + }, + { + "name": "dav" + }, + { + "name": "dav-KE" + }, + { + "name": "de" + }, + { + "name": "de-AT" + }, + { + "name": "de-BE" + }, + { + "name": "de-CH" + }, + { + "name": "de-DE" + }, + { + "name": "de-IT" + }, + { + "name": "de-LI" + }, + { + "name": "de-LU" + }, + { + "name": "dje" + }, + { + "name": "dje-NE" + }, + { + "name": "doi" + }, + { + "name": "doi-IN" + }, + { + "name": "dsb" + }, + { + "name": "dsb-DE" + }, + { + "name": "dua" + }, + { + "name": "dua-CM" + }, + { + "name": "dv" + }, + { + "name": "dv-MV" + }, + { + "name": "dyo" + }, + { + "name": "dyo-SN" + }, + { + "name": "dz" + }, + { + "name": "dz-BT" + }, + { + "name": "ebu" + }, + { + "name": "ebu-KE" + }, + { + "name": "ee" + }, + { + "name": "ee-GH" + }, + { + "name": "ee-TG" + }, + { + "name": "el" + }, + { + "name": "el-CY" + }, + { + "name": "el-GR" + }, + { + "name": "en" + }, + { + "name": "en-001" + }, + { + "name": "en-029" + }, + { + "name": "en-150" + }, + { + "name": "en-AE" + }, + { + "name": "en-AG" + }, + { + "name": "en-AI" + }, + { + "name": "en-AS" + }, + { + "name": "en-AT" + }, + { + "name": "en-AU" + }, + { + "name": "en-BB" + }, + { + "name": "en-BE" + }, + { + "name": "en-BI" + }, + { + "name": "en-BM" + }, + { + "name": "en-BS" + }, + { + "name": "en-BW" + }, + { + "name": "en-BZ" + }, + { + "name": "en-CA" + }, + { + "name": "en-CC" + }, + { + "name": "en-CH" + }, + { + "name": "en-CK" + }, + { + "name": "en-CM" + }, + { + "name": "en-CX" + }, + { + "name": "en-CY" + }, + { + "name": "en-DE" + }, + { + "name": "en-DK" + }, + { + "name": "en-DM" + }, + { + "name": "en-ER" + }, + { + "name": "en-FI" + }, + { + "name": "en-FJ" + }, + { + "name": "en-FK" + }, + { + "name": "en-FM" + }, + { + "name": "en-GB" + }, + { + "name": "en-GD" + }, + { + "name": "en-GG" + }, + { + "name": "en-GH" + }, + { + "name": "en-GI" + }, + { + "name": "en-GM" + }, + { + "name": "en-GU" + }, + { + "name": "en-GY" + }, + { + "name": "en-HK" + }, + { + "name": "en-ID" + }, + { + "name": "en-IE" + }, + { + "name": "en-IL" + }, + { + "name": "en-IM" + }, + { + "name": "en-IN" + }, + { + "name": "en-IO" + }, + { + "name": "en-JE" + }, + { + "name": "en-JM" + }, + { + "name": "en-KE" + }, + { + "name": "en-KI" + }, + { + "name": "en-KN" + }, + { + "name": "en-KY" + }, + { + "name": "en-LC" + }, + { + "name": "en-LR" + }, + { + "name": "en-LS" + }, + { + "name": "en-MG" + }, + { + "name": "en-MH" + }, + { + "name": "en-MO" + }, + { + "name": "en-MP" + }, + { + "name": "en-MS" + }, + { + "name": "en-MT" + }, + { + "name": "en-MU" + }, + { + "name": "en-MV" + }, + { + "name": "en-MW" + }, + { + "name": "en-MY" + }, + { + "name": "en-NA" + }, + { + "name": "en-NF" + }, + { + "name": "en-NG" + }, + { + "name": "en-NL" + }, + { + "name": "en-NR" + }, + { + "name": "en-NU" + }, + { + "name": "en-NZ" + }, + { + "name": "en-PG" + }, + { + "name": "en-PH" + }, + { + "name": "en-PK" + }, + { + "name": "en-PN" + }, + { + "name": "en-PR" + }, + { + "name": "en-PW" + }, + { + "name": "en-RW" + }, + { + "name": "en-SB" + }, + { + "name": "en-SC" + }, + { + "name": "en-SD" + }, + { + "name": "en-SE" + }, + { + "name": "en-SG" + }, + { + "name": "en-SH" + }, + { + "name": "en-SI" + }, + { + "name": "en-SL" + }, + { + "name": "en-SS" + }, + { + "name": "en-SX" + }, + { + "name": "en-SZ" + }, + { + "name": "en-TC" + }, + { + "name": "en-TK" + }, + { + "name": "en-TO" + }, + { + "name": "en-TT" + }, + { + "name": "en-TV" + }, + { + "name": "en-TZ" + }, + { + "name": "en-UG" + }, + { + "name": "en-UM" + }, + { + "name": "en-US" + }, + { + "name": "en-US-POSIX" + }, + { + "name": "en-VC" + }, + { + "name": "en-VG" + }, + { + "name": "en-VI" + }, + { + "name": "en-VU" + }, + { + "name": "en-WS" + }, + { + "name": "en-ZA" + }, + { + "name": "en-ZM" + }, + { + "name": "en-ZW" + }, + { + "name": "eo" + }, + { + "name": "eo-001" + }, + { + "name": "es" + }, + { + "name": "es-419" + }, + { + "name": "es-AR" + }, + { + "name": "es-BO" + }, + { + "name": "es-BR" + }, + { + "name": "es-BZ" + }, + { + "name": "es-CL" + }, + { + "name": "es-CO" + }, + { + "name": "es-CR" + }, + { + "name": "es-CU" + }, + { + "name": "es-DO" + }, + { + "name": "es-EC" + }, + { + "name": "es-ES" + }, + { + "name": "es-GQ" + }, + { + "name": "es-GT" + }, + { + "name": "es-HN" + }, + { + "name": "es-MX" + }, + { + "name": "es-NI" + }, + { + "name": "es-PA" + }, + { + "name": "es-PE" + }, + { + "name": "es-PH" + }, + { + "name": "es-PR" + }, + { + "name": "es-PY" + }, + { + "name": "es-SV" + }, + { + "name": "es-US" + }, + { + "name": "es-UY" + }, + { + "name": "es-VE" + }, + { + "name": "et" + }, + { + "name": "et-EE" + }, + { + "name": "eu" + }, + { + "name": "eu-ES" + }, + { + "name": "ewo" + }, + { + "name": "ewo-CM" + }, + { + "name": "fa" + }, + { + "name": "fa-AF" + }, + { + "name": "fa-IR" + }, + { + "name": "ff" + }, + { + "name": "ff-Adlm" + }, + { + "name": "ff-Adlm-BF" + }, + { + "name": "ff-Adlm-CM" + }, + { + "name": "ff-Adlm-GH" + }, + { + "name": "ff-Adlm-GM" + }, + { + "name": "ff-Adlm-GN" + }, + { + "name": "ff-Adlm-GW" + }, + { + "name": "ff-Adlm-LR" + }, + { + "name": "ff-Adlm-MR" + }, + { + "name": "ff-Adlm-NE" + }, + { + "name": "ff-Adlm-NG" + }, + { + "name": "ff-Adlm-SL" + }, + { + "name": "ff-Adlm-SN" + }, + { + "name": "ff-Latn" + }, + { + "name": "ff-Latn-BF" + }, + { + "name": "ff-Latn-CM" + }, + { + "name": "ff-Latn-GH" + }, + { + "name": "ff-Latn-GM" + }, + { + "name": "ff-Latn-GN" + }, + { + "name": "ff-Latn-GW" + }, + { + "name": "ff-Latn-LR" + }, + { + "name": "ff-Latn-MR" + }, + { + "name": "ff-Latn-NE" + }, + { + "name": "ff-Latn-NG" + }, + { + "name": "ff-Latn-SL" + }, + { + "name": "ff-Latn-SN" + }, + { + "name": "fi" + }, + { + "name": "fi-FI" + }, + { + "name": "fil" + }, + { + "name": "fil-PH" + }, + { + "name": "fo" + }, + { + "name": "fo-DK" + }, + { + "name": "fo-FO" + }, + { + "name": "fr" + }, + { + "name": "fr-029" + }, + { + "name": "fr-BE" + }, + { + "name": "fr-BF" + }, + { + "name": "fr-BI" + }, + { + "name": "fr-BJ" + }, + { + "name": "fr-BL" + }, + { + "name": "fr-CA" + }, + { + "name": "fr-CD" + }, + { + "name": "fr-CF" + }, + { + "name": "fr-CG" + }, + { + "name": "fr-CH" + }, + { + "name": "fr-CI" + }, + { + "name": "fr-CM" + }, + { + "name": "fr-DJ" + }, + { + "name": "fr-DZ" + }, + { + "name": "fr-FR" + }, + { + "name": "fr-GA" + }, + { + "name": "fr-GF" + }, + { + "name": "fr-GN" + }, + { + "name": "fr-GP" + }, + { + "name": "fr-GQ" + }, + { + "name": "fr-HT" + }, + { + "name": "fr-KM" + }, + { + "name": "fr-LU" + }, + { + "name": "fr-MA" + }, + { + "name": "fr-MC" + }, + { + "name": "fr-MF" + }, + { + "name": "fr-MG" + }, + { + "name": "fr-ML" + }, + { + "name": "fr-MQ" + }, + { + "name": "fr-MR" + }, + { + "name": "fr-MU" + }, + { + "name": "fr-NC" + }, + { + "name": "fr-NE" + }, + { + "name": "fr-PF" + }, + { + "name": "fr-PM" + }, + { + "name": "fr-RE" + }, + { + "name": "fr-RW" + }, + { + "name": "fr-SC" + }, + { + "name": "fr-SN" + }, + { + "name": "fr-SY" + }, + { + "name": "fr-TD" + }, + { + "name": "fr-TG" + }, + { + "name": "fr-TN" + }, + { + "name": "fr-VU" + }, + { + "name": "fr-WF" + }, + { + "name": "fr-YT" + }, + { + "name": "fur" + }, + { + "name": "fur-IT" + }, + { + "name": "fy" + }, + { + "name": "fy-NL" + }, + { + "name": "ga" + }, + { + "name": "ga-GB" + }, + { + "name": "ga-IE" + }, + { + "name": "gd" + }, + { + "name": "gd-GB" + }, + { + "name": "gl" + }, + { + "name": "gl-ES" + }, + { + "name": "gn" + }, + { + "name": "gn-PY" + }, + { + "name": "gsw" + }, + { + "name": "gsw-CH" + }, + { + "name": "gsw-FR" + }, + { + "name": "gsw-LI" + }, + { + "name": "gu" + }, + { + "name": "gu-IN" + }, + { + "name": "guz" + }, + { + "name": "guz-KE" + }, + { + "name": "gv" + }, + { + "name": "gv-IM" + }, + { + "name": "ha" + }, + { + "name": "ha-GH" + }, + { + "name": "ha-NE" + }, + { + "name": "ha-NG" + }, + { + "name": "haw" + }, + { + "name": "haw-US" + }, + { + "name": "he" + }, + { + "name": "he-IL" + }, + { + "name": "hi" + }, + { + "name": "hi-IN" + }, + { + "name": "hi-Latn" + }, + { + "name": "hi-Latn-IN" + }, + { + "name": "hr" + }, + { + "name": "hr-BA" + }, + { + "name": "hr-HR" + }, + { + "name": "hsb" + }, + { + "name": "hsb-DE" + }, + { + "name": "hu" + }, + { + "name": "hu-HU" + }, + { + "name": "hy" + }, + { + "name": "hy-AM" + }, + { + "name": "ia" + }, + { + "name": "ia-001" + }, + { + "name": "ibb" + }, + { + "name": "ibb-NG" + }, + { + "name": "id" + }, + { + "name": "id-ID" + }, + { + "name": "ig" + }, + { + "name": "ig-NG" + }, + { + "name": "ii" + }, + { + "name": "ii-CN" + }, + { + "name": "is" + }, + { + "name": "is-IS" + }, + { + "name": "it" + }, + { + "name": "it-CH" + }, + { + "name": "it-IT" + }, + { + "name": "it-SM" + }, + { + "name": "it-VA" + }, + { + "name": "iu" + }, + { + "name": "iu-CA" + }, + { + "name": "iu-Latn" + }, + { + "name": "iu-Latn-CA" + }, + { + "name": "ja" + }, + { + "name": "ja-JP" + }, + { + "name": "jgo" + }, + { + "name": "jgo-CM" + }, + { + "name": "jmc" + }, + { + "name": "jmc-TZ" + }, + { + "name": "jv" + }, + { + "name": "jv-ID" + }, + { + "name": "jv-Java" + }, + { + "name": "jv-Java-ID" + }, + { + "name": "ka" + }, + { + "name": "ka-GE" + }, + { + "name": "kab" + }, + { + "name": "kab-DZ" + }, + { + "name": "kam" + }, + { + "name": "kam-KE" + }, + { + "name": "kde" + }, + { + "name": "kde-TZ" + }, + { + "name": "kea" + }, + { + "name": "kea-CV" + }, + { + "name": "kgp" + }, + { + "name": "kgp-BR" + }, + { + "name": "khq" + }, + { + "name": "khq-ML" + }, + { + "name": "ki" + }, + { + "name": "ki-KE" + }, + { + "name": "kk" + }, + { + "name": "kk-KZ" + }, + { + "name": "kkj" + }, + { + "name": "kkj-CM" + }, + { + "name": "kl" + }, + { + "name": "kl-GL" + }, + { + "name": "kln" + }, + { + "name": "kln-KE" + }, + { + "name": "km" + }, + { + "name": "km-KH" + }, + { + "name": "kn" + }, + { + "name": "kn-IN" + }, + { + "name": "ko" + }, + { + "name": "ko-KP" + }, + { + "name": "ko-KR" + }, + { + "name": "kok" + }, + { + "name": "kok-IN" + }, + { + "name": "kr" + }, + { + "name": "kr-Latn" + }, + { + "name": "kr-Latn-NG" + }, + { + "name": "ks" + }, + { + "name": "ks-Arab" + }, + { + "name": "ks-Arab-IN" + }, + { + "name": "ks-Deva" + }, + { + "name": "ks-Deva-IN" + }, + { + "name": "ksb" + }, + { + "name": "ksb-TZ" + }, + { + "name": "ksf" + }, + { + "name": "ksf-CM" + }, + { + "name": "ksh" + }, + { + "name": "ksh-DE" + }, + { + "name": "kw" + }, + { + "name": "kw-GB" + }, + { + "name": "ky" + }, + { + "name": "ky-KG" + }, + { + "name": "la" + }, + { + "name": "la-VA" + }, + { + "name": "lag" + }, + { + "name": "lag-TZ" + }, + { + "name": "lb" + }, + { + "name": "lb-LU" + }, + { + "name": "lg" + }, + { + "name": "lg-UG" + }, + { + "name": "lkt" + }, + { + "name": "lkt-US" + }, + { + "name": "ln" + }, + { + "name": "ln-AO" + }, + { + "name": "ln-CD" + }, + { + "name": "ln-CF" + }, + { + "name": "ln-CG" + }, + { + "name": "lo" + }, + { + "name": "lo-LA" + }, + { + "name": "lrc" + }, + { + "name": "lrc-IQ" + }, + { + "name": "lrc-IR" + }, + { + "name": "lt" + }, + { + "name": "lt-LT" + }, + { + "name": "lu" + }, + { + "name": "lu-CD" + }, + { + "name": "luo" + }, + { + "name": "luo-KE" + }, + { + "name": "luy" + }, + { + "name": "luy-KE" + }, + { + "name": "lv" + }, + { + "name": "lv-LV" + }, + { + "name": "mai" + }, + { + "name": "mai-IN" + }, + { + "name": "mas" + }, + { + "name": "mas-KE" + }, + { + "name": "mas-TZ" + }, + { + "name": "mer" + }, + { + "name": "mer-KE" + }, + { + "name": "mfe" + }, + { + "name": "mfe-MU" + }, + { + "name": "mg" + }, + { + "name": "mg-MG" + }, + { + "name": "mgh" + }, + { + "name": "mgh-MZ" + }, + { + "name": "mgo" + }, + { + "name": "mgo-CM" + }, + { + "name": "mi" + }, + { + "name": "mi-NZ" + }, + { + "name": "mk" + }, + { + "name": "mk-MK" + }, + { + "name": "ml" + }, + { + "name": "ml-IN" + }, + { + "name": "mn" + }, + { + "name": "mn-MN" + }, + { + "name": "mn-Mong" + }, + { + "name": "mn-Mong-CN" + }, + { + "name": "mn-Mong-MN" + }, + { + "name": "mni" + }, + { + "name": "mni-Beng" + }, + { + "name": "mni-Beng-IN" + }, + { + "name": "moh" + }, + { + "name": "moh-CA" + }, + { + "name": "mr" + }, + { + "name": "mr-IN" + }, + { + "name": "ms" + }, + { + "name": "ms-BN" + }, + { + "name": "ms-ID" + }, + { + "name": "ms-MY" + }, + { + "name": "ms-SG" + }, + { + "name": "mt" + }, + { + "name": "mt-MT" + }, + { + "name": "mua" + }, + { + "name": "mua-CM" + }, + { + "name": "my" + }, + { + "name": "my-MM" + }, + { + "name": "mzn" + }, + { + "name": "mzn-IR" + }, + { + "name": "naq" + }, + { + "name": "naq-NA" + }, + { + "name": "nb" + }, + { + "name": "nb-NO" + }, + { + "name": "nb-SJ" + }, + { + "name": "nd" + }, + { + "name": "nd-ZW" + }, + { + "name": "nds" + }, + { + "name": "nds-DE" + }, + { + "name": "nds-NL" + }, + { + "name": "ne" + }, + { + "name": "ne-IN" + }, + { + "name": "ne-NP" + }, + { + "name": "nl" + }, + { + "name": "nl-AW" + }, + { + "name": "nl-BE" + }, + { + "name": "nl-BQ" + }, + { + "name": "nl-CW" + }, + { + "name": "nl-NL" + }, + { + "name": "nl-SR" + }, + { + "name": "nl-SX" + }, + { + "name": "nmg" + }, + { + "name": "nmg-CM" + }, + { + "name": "nn" + }, + { + "name": "nn-NO" + }, + { + "name": "nnh" + }, + { + "name": "nnh-CM" + }, + { + "name": "no" + }, + { + "name": "nqo" + }, + { + "name": "nqo-GN" + }, + { + "name": "nr" + }, + { + "name": "nr-ZA" + }, + { + "name": "nso" + }, + { + "name": "nso-ZA" + }, + { + "name": "nus" + }, + { + "name": "nus-SS" + }, + { + "name": "nyn" + }, + { + "name": "nyn-UG" + }, + { + "name": "oc" + }, + { + "name": "oc-ES" + }, + { + "name": "oc-FR" + }, + { + "name": "om" + }, + { + "name": "om-ET" + }, + { + "name": "om-KE" + }, + { + "name": "or" + }, + { + "name": "or-IN" + }, + { + "name": "os" + }, + { + "name": "os-GE" + }, + { + "name": "os-RU" + }, + { + "name": "pa" + }, + { + "name": "pa-Arab" + }, + { + "name": "pa-Arab-PK" + }, + { + "name": "pa-Guru" + }, + { + "name": "pa-Guru-IN" + }, + { + "name": "pap" + }, + { + "name": "pap-029" + }, + { + "name": "pcm" + }, + { + "name": "pcm-NG" + }, + { + "name": "pl" + }, + { + "name": "pl-PL" + }, + { + "name": "prg" + }, + { + "name": "prg-001" + }, + { + "name": "ps" + }, + { + "name": "ps-AF" + }, + { + "name": "ps-PK" + }, + { + "name": "pt" + }, + { + "name": "pt-AO" + }, + { + "name": "pt-BR" + }, + { + "name": "pt-CH" + }, + { + "name": "pt-CV" + }, + { + "name": "pt-GQ" + }, + { + "name": "pt-GW" + }, + { + "name": "pt-LU" + }, + { + "name": "pt-MO" + }, + { + "name": "pt-MZ" + }, + { + "name": "pt-PT" + }, + { + "name": "pt-ST" + }, + { + "name": "pt-TL" + }, + { + "name": "qu" + }, + { + "name": "qu-BO" + }, + { + "name": "qu-EC" + }, + { + "name": "qu-PE" + }, + { + "name": "quc" + }, + { + "name": "quc-GT" + }, + { + "name": "raj" + }, + { + "name": "raj-IN" + }, + { + "name": "rm" + }, + { + "name": "rm-CH" + }, + { + "name": "rn" + }, + { + "name": "rn-BI" + }, + { + "name": "ro" + }, + { + "name": "ro-MD" + }, + { + "name": "ro-RO" + }, + { + "name": "rof" + }, + { + "name": "rof-TZ" + }, + { + "name": "ru" + }, + { + "name": "ru-BY" + }, + { + "name": "ru-KG" + }, + { + "name": "ru-KZ" + }, + { + "name": "ru-MD" + }, + { + "name": "ru-RU" + }, + { + "name": "ru-UA" + }, + { + "name": "rw" + }, + { + "name": "rw-RW" + }, + { + "name": "rwk" + }, + { + "name": "rwk-TZ" + }, + { + "name": "sa" + }, + { + "name": "sa-IN" + }, + { + "name": "sah" + }, + { + "name": "sah-RU" + }, + { + "name": "saq" + }, + { + "name": "saq-KE" + }, + { + "name": "sat" + }, + { + "name": "sat-Olck" + }, + { + "name": "sat-Olck-IN" + }, + { + "name": "sbp" + }, + { + "name": "sbp-TZ" + }, + { + "name": "sc" + }, + { + "name": "sc-IT" + }, + { + "name": "sd" + }, + { + "name": "sd-Arab" + }, + { + "name": "sd-Arab-PK" + }, + { + "name": "sd-Deva" + }, + { + "name": "sd-Deva-IN" + }, + { + "name": "se" + }, + { + "name": "se-FI" + }, + { + "name": "se-NO" + }, + { + "name": "se-SE" + }, + { + "name": "seh" + }, + { + "name": "seh-MZ" + }, + { + "name": "ses" + }, + { + "name": "ses-ML" + }, + { + "name": "sg" + }, + { + "name": "sg-CF" + }, + { + "name": "shi" + }, + { + "name": "shi-Latn" + }, + { + "name": "shi-Latn-MA" + }, + { + "name": "shi-Tfng" + }, + { + "name": "shi-Tfng-MA" + }, + { + "name": "si" + }, + { + "name": "si-LK" + }, + { + "name": "sk" + }, + { + "name": "sk-SK" + }, + { + "name": "sl" + }, + { + "name": "sl-SI" + }, + { + "name": "sma" + }, + { + "name": "sma-NO" + }, + { + "name": "sma-SE" + }, + { + "name": "smj" + }, + { + "name": "smj-NO" + }, + { + "name": "smj-SE" + }, + { + "name": "smn" + }, + { + "name": "smn-FI" + }, + { + "name": "sms" + }, + { + "name": "sms-FI" + }, + { + "name": "sn" + }, + { + "name": "sn-ZW" + }, + { + "name": "so" + }, + { + "name": "so-DJ" + }, + { + "name": "so-ET" + }, + { + "name": "so-KE" + }, + { + "name": "so-SO" + }, + { + "name": "sq" + }, + { + "name": "sq-AL" + }, + { + "name": "sq-MK" + }, + { + "name": "sq-XK" + }, + { + "name": "sr" + }, + { + "name": "sr-Cyrl" + }, + { + "name": "sr-Cyrl-BA" + }, + { + "name": "sr-Cyrl-ME" + }, + { + "name": "sr-Cyrl-RS" + }, + { + "name": "sr-Cyrl-XK" + }, + { + "name": "sr-Latn" + }, + { + "name": "sr-Latn-BA" + }, + { + "name": "sr-Latn-ME" + }, + { + "name": "sr-Latn-RS" + }, + { + "name": "sr-Latn-XK" + }, + { + "name": "ss" + }, + { + "name": "ss-SZ" + }, + { + "name": "ss-ZA" + }, + { + "name": "ssy" + }, + { + "name": "ssy-ER" + }, + { + "name": "st" + }, + { + "name": "st-LS" + }, + { + "name": "st-ZA" + }, + { + "name": "su" + }, + { + "name": "su-Latn" + }, + { + "name": "su-Latn-ID" + }, + { + "name": "sv" + }, + { + "name": "sv-AX" + }, + { + "name": "sv-FI" + }, + { + "name": "sv-SE" + }, + { + "name": "sw" + }, + { + "name": "sw-CD" + }, + { + "name": "sw-KE" + }, + { + "name": "sw-TZ" + }, + { + "name": "sw-UG" + }, + { + "name": "syr" + }, + { + "name": "syr-SY" + }, + { + "name": "ta" + }, + { + "name": "ta-IN" + }, + { + "name": "ta-LK" + }, + { + "name": "ta-MY" + }, + { + "name": "ta-SG" + }, + { + "name": "te" + }, + { + "name": "te-IN" + }, + { + "name": "teo" + }, + { + "name": "teo-KE" + }, + { + "name": "teo-UG" + }, + { + "name": "tg" + }, + { + "name": "tg-TJ" + }, + { + "name": "th" + }, + { + "name": "th-TH" + }, + { + "name": "ti" + }, + { + "name": "ti-ER" + }, + { + "name": "ti-ET" + }, + { + "name": "tig" + }, + { + "name": "tig-ER" + }, + { + "name": "tk" + }, + { + "name": "tk-TM" + }, + { + "name": "tn" + }, + { + "name": "tn-BW" + }, + { + "name": "tn-ZA" + }, + { + "name": "to" + }, + { + "name": "to-TO" + }, + { + "name": "tr" + }, + { + "name": "tr-CY" + }, + { + "name": "tr-TR" + }, + { + "name": "ts" + }, + { + "name": "ts-ZA" + }, + { + "name": "tt" + }, + { + "name": "tt-RU" + }, + { + "name": "twq" + }, + { + "name": "twq-NE" + }, + { + "name": "tzm" + }, + { + "name": "tzm-Arab" + }, + { + "name": "tzm-Arab-MA" + }, + { + "name": "tzm-DZ" + }, + { + "name": "tzm-MA" + }, + { + "name": "tzm-Tfng" + }, + { + "name": "tzm-Tfng-MA" + }, + { + "name": "ug" + }, + { + "name": "ug-CN" + }, + { + "name": "uk" + }, + { + "name": "uk-UA" + }, + { + "name": "ur" + }, + { + "name": "ur-IN" + }, + { + "name": "ur-PK" + }, + { + "name": "uz" + }, + { + "name": "uz-Arab" + }, + { + "name": "uz-Arab-AF" + }, + { + "name": "uz-Cyrl" + }, + { + "name": "uz-Cyrl-UZ" + }, + { + "name": "uz-Latn" + }, + { + "name": "uz-Latn-UZ" + }, + { + "name": "vai" + }, + { + "name": "vai-Latn" + }, + { + "name": "vai-Latn-LR" + }, + { + "name": "vai-Vaii" + }, + { + "name": "vai-Vaii-LR" + }, + { + "name": "ve" + }, + { + "name": "ve-ZA" + }, + { + "name": "vi" + }, + { + "name": "vi-VN" + }, + { + "name": "vo" + }, + { + "name": "vo-001" + }, + { + "name": "vun" + }, + { + "name": "vun-TZ" + }, + { + "name": "wae" + }, + { + "name": "wae-CH" + }, + { + "name": "wal" + }, + { + "name": "wal-ET" + }, + { + "name": "wo" + }, + { + "name": "wo-SN" + }, + { + "name": "xh" + }, + { + "name": "xh-ZA" + }, + { + "name": "xog" + }, + { + "name": "xog-UG" + }, + { + "name": "yav" + }, + { + "name": "yav-CM" + }, + { + "name": "yi" + }, + { + "name": "yi-001" + }, + { + "name": "yo" + }, + { + "name": "yo-BJ" + }, + { + "name": "yo-NG" + }, + { + "name": "yrl" + }, + { + "name": "yrl-BR" + }, + { + "name": "yrl-CO" + }, + { + "name": "yrl-VE" + }, + { + "name": "zgh" + }, + { + "name": "zgh-MA" + }, + { + "name": "zh" + }, + { + "name": "zh-Hans" + }, + { + "name": "zh-Hans-CN" + }, + { + "name": "zh-Hans-HK" + }, + { + "name": "zh-Hans-MO" + }, + { + "name": "zh-Hans-SG" + }, + { + "name": "zh-Hant" + }, + { + "name": "zh-Hant-HK" + }, + { + "name": "zh-Hant-MO" + }, + { + "name": "zh-Hant-TW" + }, + { + "name": "zu" + }, + { + "name": "zu-ZA" + } + ] } ], - "description": "Retrieve a specific culture based on the name.\n" + "description": "Retrieve a specific culture based on the name." }, { "name": "-NoUserOverrides", - "description": "Ignore user changes for current culture.\n" + "description": "Ignore user changes for current culture." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/get-dapolicychange.json b/command-signatures/json/autogenerated/powershell/get-dapolicychange.json new file mode 100644 index 00000000..f297727d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-dapolicychange.json @@ -0,0 +1,277 @@ +{ + "name": "Get-DAPolicyChange", + "options": [ + { + "name": "-DisplayName", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the display name to match the differences in IP addresses of the IPsec rule." + }, + { + "name": "-DnsServers", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies a list of DNS server IP addresses that will be used for name resolution used to determine IP address differences. This parameter accepts one or more DNS server IP addresses. If this parameter is not specified, then this cmdlet uses the default DNS servers." + }, + { + "name": "-Domains", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies the domains from which the deltas in IP addresses are derived. The list is specified by an array of fully qualified domain names (FQDN)." + }, + { + "name": "-EndpointType", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies that the local or remote endpoint should be modified by adding or removing the IP address differences. The acceptable values for this parameter are: Endpoint1 or Endpoint2. Endpoint1 corresponds to the local address and Endpoint2 corresponds to the remote address for any IPsec rule." + }, + { + "name": "-PolicyStore", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the policy store from which to retrieve the rules to be retrieved. A policy store is a container for firewall and IPsec policy. The acceptable values for this parameter are:" + }, + { + "name": "-PSLocation", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the path for the newly created Windows PowerShell script (`.ps1`) file. This parameter supports standard Windows PowerShell path syntax. This parameter must contain a rooted path, such as `C:\\users\\User1\\WPS_Script.ps1`." + }, + { + "name": "-Servers", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies a list of server IP addresses that will be used to derive IP address differences." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Servers", + "description": "Specifies a list of server IP addresses that will be used to derive IP address differences." + }, + { + "name": "-Domains", + "description": "Specifies the domains from which the deltas in IP addresses are derived. The list is specified by an array of fully qualified domain names (FQDN)." + }, + { + "name": "-DisplayName", + "description": "Specifies the display name to match the differences in IP addresses of the IPsec rule." + }, + { + "name": "-PolicyStore", + "description": "Specifies the policy store from which to retrieve the rules to be retrieved. A policy store is a container for firewall and IPsec policy. The acceptable values for this parameter are:" + }, + { + "name": "-PSLocation", + "description": "Specifies the path for the newly created Windows PowerShell script (`.ps1`) file. This parameter supports standard Windows PowerShell path syntax. This parameter must contain a rooted path, such as `C:\\users\\User1\\WPS_Script.ps1`." + }, + { + "name": "-EndpointType", + "description": "Specifies that the local or remote endpoint should be modified by adding or removing the IP address differences. The acceptable values for this parameter are: Endpoint1 or Endpoint2. Endpoint1 corresponds to the local address and Endpoint2 corresponds to the remote address for any IPsec rule." + }, + { + "name": "-DnsServers", + "description": "Specifies a list of DNS server IP addresses that will be used for name resolution used to determine IP address differences. This parameter accepts one or more DNS server IP addresses. If this parameter is not specified, then this cmdlet uses the default DNS servers." + } + ], + "description": "Gets a list of IP addresses that need to be added and deleted to an IPsec rule based on the differences detected between the IP addresses for the existing rule and the IP addresses derived from the input parameters, and creates a Windows PowerShell® script (.ps1) that updates the IPsec rule in the appropriate policy stores.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-date.json b/command-signatures/json/autogenerated/powershell/get-date.json index 55cc40c8..07d159d9 100644 --- a/command-signatures/json/autogenerated/powershell/get-date.json +++ b/command-signatures/json/autogenerated/powershell/get-date.json @@ -3,7 +3,7 @@ "options": [ { "name": "-AsUTC", - "description": "Converts the date value to the equivalent time in UTC.\n" + "description": "Converts the date value to the equivalent time in UTC." }, { "name": [ @@ -15,7 +15,7 @@ "name": "System.DateTime" } ], - "description": "Specifies a date and time. Time is optional and if not specified, returns 00:00:00. Enter the date and time in a format that is standard for the currently selected locale. You can change the current locale using the `Set-Culture` cmdlet.\n" + "description": "Specifies a date and time. Time is optional and if not specified, returns 00:00:00. Enter the date and time in a format that is standard for the currently selected locale. You can change the current locale using the `Set-Culture` cmdlet." }, { "name": "-Day", @@ -24,7 +24,7 @@ "name": "System.Int32" } ], - "description": "Specifies the day of the month that is displayed. Enter a value from 1 to 31.\n" + "description": "Specifies the day of the month that is displayed. Enter a value from 1 to 31." }, { "name": "-DisplayHint", @@ -36,15 +36,15 @@ "name": "Date" }, { - "name": "Time" + "name": "DateTime" }, { - "name": "DateTime" + "name": "Time" } ] } ], - "description": "Determines which elements of the date and time are displayed.\n" + "description": "Determines which elements of the date and time are displayed." }, { "name": "-Format", @@ -53,7 +53,7 @@ "name": "System.String" } ], - "description": "Displays the date and time in the Microsoft .NET Framework format indicated by the format specifier. The Format parameter outputs a String object.\n" + "description": "Displays the date and time in the Microsoft .NET Framework format indicated by the format specifier. The Format parameter outputs a String object." }, { "name": "-Hour", @@ -71,7 +71,7 @@ "name": "System.Int32" } ], - "description": "Specifies the milliseconds in the date. Enter a value from 0 to 999.\n" + "description": "Specifies the milliseconds in the date. Enter a value from 0 to 999." }, { "name": "-Minute", @@ -107,7 +107,7 @@ "name": "System.String" } ], - "description": "Displays the date and time in UNIX format. The UFormat parameter outputs a string object. UFormat specifiers are preceded by a percent sign (`%`), for example, `%m`, `%d`, and `%Y`. The Notes (#notes)section contains a table of valid UFormat specifiers .\n" + "description": "Displays the date and time in Unix format. The UFormat parameter outputs a string object." }, { "name": [ @@ -120,7 +120,7 @@ } ], "isRequired": true, - "description": "Date and time represented in seconds since January 1, 1970, 0:00:00.\n" + "description": "Date and time represented in seconds since January 1, 1970, 0:00:00." }, { "name": "-Year", @@ -305,7 +305,7 @@ "args": [ { "name": "-Date", - "description": "Specifies a date and time. Time is optional and if not specified, returns 00:00:00. Enter the date and time in a format that is standard for the currently selected locale. You can change the current locale using the `Set-Culture` cmdlet.\n" + "description": "Specifies a date and time. Time is optional and if not specified, returns 00:00:00. Enter the date and time in a format that is standard for the currently selected locale. You can change the current locale using the `Set-Culture` cmdlet." } ], "description": "Gets the current date and time.", diff --git a/command-signatures/json/autogenerated/powershell/get-deliveryoptimizationlog.json b/command-signatures/json/autogenerated/powershell/get-deliveryoptimizationlog.json new file mode 100644 index 00000000..861d4411 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-deliveryoptimizationlog.json @@ -0,0 +1,229 @@ +{ + "name": "Get-DeliveryOptimizationLog", + "options": [ + { + "name": "-Flush", + "description": "{{ Fill Flush Description }}" + }, + { + "name": "-LevelFilter", + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "{{ Fill LevelFilter Description }}" + }, + { + "name": [ + "-Path", + "-PSPath" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "{{ Fill Path Description }}" + }, + { + "name": "-Provider", + "args": [ + { + "name": "Microsoft.Windows.DeliveryOptimization.AdminCommands.ProviderType", + "suggestions": [ + { + "name": "Domgmt" + }, + { + "name": "Dosvc" + } + ] + } + ], + "description": "{{ Fill Provider Description }}" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path", + "description": "{{ Fill Path Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-deliveryoptimizationloganalysis.json b/command-signatures/json/autogenerated/powershell/get-deliveryoptimizationloganalysis.json new file mode 100644 index 00000000..65f160bb --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-deliveryoptimizationloganalysis.json @@ -0,0 +1,207 @@ +{ + "name": "Get-DeliveryOptimizationLogAnalysis", + "options": [ + { + "name": "-Flush", + "description": "{{ Fill Flush Description }}" + }, + { + "name": "-ListConnections", + "description": "{{ Fill ListConnections Description }}" + }, + { + "name": [ + "-Path", + "-PSPath" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "{{ Fill Path Description }}" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path", + "description": "{{ Fill Path Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-eventlog.json b/command-signatures/json/autogenerated/powershell/get-eventlog.json new file mode 100644 index 00000000..468b1ef4 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-eventlog.json @@ -0,0 +1,319 @@ +{ + "name": "Get-EventLog", + "options": [ + { + "name": "-After", + "args": [ + { + "name": "datetime" + } + ] + }, + { + "name": "-AsBaseObject" + }, + { + "name": "-AsString" + }, + { + "name": "-Before", + "args": [ + { + "name": "datetime" + } + ] + }, + { + "name": [ + "-ComputerName", + "-Cn" + ], + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-EntryType", + "-ET" + ], + "args": [ + { + "name": "string[]", + "suggestions": [ + { + "name": "Error" + }, + { + "name": "Information" + }, + { + "name": "FailureAudit" + }, + { + "name": "SuccessAudit" + }, + { + "name": "Warning" + } + ] + } + ] + }, + { + "name": "-Index", + "args": [ + { + "name": "int[]" + } + ] + }, + { + "name": "-InstanceId", + "args": [ + { + "name": "long[]" + } + ] + }, + { + "name": "-List" + }, + { + "name": [ + "-LogName", + "-LN" + ], + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Message", + "-MSG" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Newest", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": [ + "-Source", + "-ABO" + ], + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-UserName", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-LogName" + }, + { + "name": "-InstanceId" + } + ], + "description": "Get-EventLog [-LogName] [[-InstanceId] ] [-ComputerName ] [-Newest ] [-After ] [-Before ] [-UserName ] [-Index ] [-EntryType ] [-Source ] [-Message ] [-AsBaseObject] [] Get-EventLog [-ComputerName ] [-List] [-AsString] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-executionpolicy.json b/command-signatures/json/autogenerated/powershell/get-executionpolicy.json index a03dbf12..97dd7ef1 100644 --- a/command-signatures/json/autogenerated/powershell/get-executionpolicy.json +++ b/command-signatures/json/autogenerated/powershell/get-executionpolicy.json @@ -26,11 +26,10 @@ { "name": "UserPolicy" } - ], - "default": "Effective execution policy" + ] } ], - "description": "Specifies the scope that is affected by an execution policy.\n" + "description": "Specifies the scope that is affected by an execution policy." }, { "name": [ @@ -206,7 +205,7 @@ "args": [ { "name": "-Scope", - "description": "Specifies the scope that is affected by an execution policy.\n", + "description": "Specifies the scope that is affected by an execution policy.", "suggestions": [ { "name": "CurrentUser" diff --git a/command-signatures/json/autogenerated/powershell/get-filehash.json b/command-signatures/json/autogenerated/powershell/get-filehash.json index ddc88825..6d563ef5 100644 --- a/command-signatures/json/autogenerated/powershell/get-filehash.json +++ b/command-signatures/json/autogenerated/powershell/get-filehash.json @@ -7,6 +7,9 @@ { "name": "System.String", "suggestions": [ + { + "name": "MD5" + }, { "name": "SHA1" }, @@ -18,15 +21,11 @@ }, { "name": "SHA512" - }, - { - "name": "MD5" } - ], - "default": "SHA256" + ] } ], - "description": "Specifies the cryptographic hash function to use for computing the hash value of the contents of the specified file or stream. A cryptographic hash function has the property that it is infeasible to find two different files with the same hash value. Hash functions are commonly used with digital signatures and for data integrity. The acceptable values for this parameter are:\n" + "description": "Specifies the cryptographic hash function to use for computing the hash value of the contents of the specified file or stream. A cryptographic hash function has the property that it is infeasible to find two different files with the same hash value. Hash functions are commonly used with digital signatures and for data integrity. The acceptable values for this parameter are:" }, { "name": "-InputStream", @@ -239,8 +238,11 @@ }, { "name": "-Algorithm", - "description": "Specifies the cryptographic hash function to use for computing the hash value of the contents of the specified file or stream. A cryptographic hash function has the property that it is infeasible to find two different files with the same hash value. Hash functions are commonly used with digital signatures and for data integrity. The acceptable values for this parameter are:\n", + "description": "Specifies the cryptographic hash function to use for computing the hash value of the contents of the specified file or stream. A cryptographic hash function has the property that it is infeasible to find two different files with the same hash value. Hash functions are commonly used with digital signatures and for data integrity. The acceptable values for this parameter are:", "suggestions": [ + { + "name": "MD5" + }, { "name": "SHA1" }, @@ -252,9 +254,6 @@ }, { "name": "SHA512" - }, - { - "name": "MD5" } ] } diff --git a/command-signatures/json/autogenerated/powershell/get-formatdata.json b/command-signatures/json/autogenerated/powershell/get-formatdata.json index e900f290..89780efb 100644 --- a/command-signatures/json/autogenerated/powershell/get-formatdata.json +++ b/command-signatures/json/autogenerated/powershell/get-formatdata.json @@ -8,7 +8,7 @@ "name": "System.Version" } ], - "description": "Specify the version of PowerShell this cmdlet gets for the formatting data. Enter a two digit number separated by a period.\n" + "description": "Specify the version of PowerShell this cmdlet gets for the formatting data. Enter a two digit number separated by a period." }, { "name": "-TypeName", diff --git a/command-signatures/json/autogenerated/powershell/get-help.json b/command-signatures/json/autogenerated/powershell/get-help.json index 9a4aaa5a..f204f7d1 100644 --- a/command-signatures/json/autogenerated/powershell/get-help.json +++ b/command-signatures/json/autogenerated/powershell/get-help.json @@ -11,57 +11,54 @@ "name": "Alias" }, { - "name": "Cmdlet" + "name": "All" }, { - "name": "Provider" + "name": "Class" }, { - "name": "General" + "name": "Cmdlet" }, { - "name": "FAQ" + "name": "Configuration" }, { - "name": "Glossary" + "name": "DefaultHelp" }, { - "name": "HelpFile" + "name": "DscResource" }, { - "name": "ScriptCommand" + "name": "ExternalScript" }, { - "name": "Function" + "name": "FAQ" }, { "name": "Filter" }, { - "name": "ExternalScript" - }, - { - "name": "All" + "name": "Function" }, { - "name": "DefaultHelp" + "name": "General" }, { - "name": "Workflow" + "name": "Glossary" }, { - "name": "DscResource" + "name": "HelpFile" }, { - "name": "Class" + "name": "Provider" }, { - "name": "Configuration" + "name": "ScriptCommand" } ] } ], - "description": "Displays help only for items in the specified category and their aliases. Conceptual articles are in the HelpFile category.\n" + "description": "Displays help only for items in the specified category and their aliases. Conceptual articles are in the HelpFile category." }, { "name": "-Component", @@ -70,21 +67,21 @@ "name": "System.String[]" } ], - "description": "Displays commands with the specified component value, such as Exchange . Enter a component name. Wildcard characters are permitted. This parameter has no effect on displays of conceptual ( About_ ) help." + "description": "Displays commands with the specified component value, such as Exchange. Enter a component name. Wildcard characters are permitted. This parameter has no effect on displays of conceptual (About_) help." }, { "name": "-Detailed", "isRequired": true, - "description": "Adds parameter descriptions and examples to the basic help display. This parameter is effective only when the help files are installed on the computer. It has no effect on displays of conceptual ( About_ ) help." + "description": "Adds parameter descriptions and examples to the basic help display. This parameter is effective only when the help files are installed on the computer. It has no effect on displays of conceptual (About_) help." }, { "name": "-Examples", "isRequired": true, - "description": "Displays only the name, synopsis, and examples. This parameter is effective only when the help files are installed on the computer. It has no effect on displays of conceptual ( About_ ) help." + "description": "Displays only the name, synopsis, and examples. This parameter is effective only when the help files are installed on the computer. It has no effect on displays of conceptual (About_) help." }, { "name": "-Full", - "description": "Displays the entire help article for a cmdlet. Full includes parameter descriptions and attributes, examples, input and output object types, and additional notes.\n" + "description": "Displays the entire help article for a cmdlet. Full includes parameter descriptions and attributes, examples, input and output object types, and additional notes." }, { "name": "-Functionality", @@ -93,7 +90,7 @@ "name": "System.String[]" } ], - "description": "Displays help for items with the specified functionality. Enter the functionality. Wildcard characters are permitted. This parameter has no effect on displays of conceptual ( About_ ) help." + "description": "Displays help for items with the specified functionality. Enter the functionality. Wildcard characters are permitted. This parameter has no effect on displays of conceptual (About_) help." }, { "name": "-Name", @@ -103,12 +100,12 @@ "generatorName": "get_command_names" } ], - "description": "Gets help about the specified command or concept. Enter the name of a cmdlet, function, provider, script, or workflow, such as `Get-Member`, a conceptual article name, such as `about_Objects`, or an alias, such as `ls`. Wildcard characters are permitted in cmdlet and provider names, but you can't use wildcard characters to find the names of function help and script help articles.\n" + "description": "Gets help about the specified command or concept. Enter the name of a cmdlet, function, provider, script, or workflow, such as `Get-Member`, a conceptual article name, such as `about_Objects`, or an alias, such as `ls`. Wildcard characters are permitted in cmdlet and provider names, but you can't use wildcard characters to find the names of function help and script help articles." }, { "name": "-Online", "isRequired": true, - "description": "Displays the online version of a help article in the default browser. This parameter is valid only for cmdlet, function, workflow, and script help articles. You can't use the Online parameter with `Get-Help` in a remote session.\n" + "description": "Displays the online version of a help article in the default browser. This parameter is valid only for cmdlet, function, workflow, and script help articles. You can't use the Online parameter with `Get-Help` in a remote session." }, { "name": "-Parameter", @@ -118,7 +115,7 @@ } ], "isRequired": true, - "description": "Displays only the detailed descriptions of the specified parameters. Wildcards are permitted. This parameter has no effect on displays of conceptual ( About_ ) help." + "description": "Displays only the detailed descriptions of the specified parameters. Wildcards are permitted. This parameter has no effect on displays of conceptual (About_) help." }, { "name": "-Path", @@ -127,7 +124,7 @@ "name": "System.String" } ], - "description": "Gets help that explains how the cmdlet works in the specified provider path. Enter a PowerShell provider path.\n" + "description": "Gets help that explains how the cmdlet works in the specified provider path. Enter a PowerShell provider path." }, { "name": "-Role", @@ -136,12 +133,12 @@ "name": "System.String[]" } ], - "description": "Displays help customized for the specified user role. Enter a role. Wildcard characters are permitted.\n" + "description": "Displays help customized for the specified user role. Enter a role. Wildcard characters are permitted." }, { "name": "-ShowWindow", "isRequired": true, - "description": "Displays the help topic in a window for easier reading. The window includes a Find search feature and a Settings box that lets you set options for the display, including options to display only selected sections of a help topic.\n" + "description": "Displays the help topic in a window for easier reading. The window includes a Find search feature and a Settings box that lets you set options for the display, including options to display only selected sections of a help topic." }, { "name": [ @@ -317,7 +314,7 @@ "args": [ { "name": "-Name", - "description": "Gets help about the specified command or concept. Enter the name of a cmdlet, function, provider, script, or workflow, such as `Get-Member`, a conceptual article name, such as `about_Objects`, or an alias, such as `ls`. Wildcard characters are permitted in cmdlet and provider names, but you can't use wildcard characters to find the names of function help and script help articles.\n", + "description": "Gets help about the specified command or concept. Enter the name of a cmdlet, function, provider, script, or workflow, such as `Get-Member`, a conceptual article name, such as `about_Objects`, or an alias, such as `ls`. Wildcard characters are permitted in cmdlet and provider names, but you can't use wildcard characters to find the names of function help and script help articles.", "generatorName": "get_command_names" } ], diff --git a/command-signatures/json/autogenerated/powershell/get-history.json b/command-signatures/json/autogenerated/powershell/get-history.json index 3f600db1..d7810ac1 100644 --- a/command-signatures/json/autogenerated/powershell/get-history.json +++ b/command-signatures/json/autogenerated/powershell/get-history.json @@ -8,7 +8,7 @@ "name": "System.Int32" } ], - "description": "Specifies the number of the most recent history entries that this cmdlet gets. By, default, `Get-History` gets all entries in the session history. If you use both the Count and Id parameters in a command, the display ends with the command that is specified by the Id parameter.\n" + "description": "Specifies the number of the most recent history entries that this cmdlet gets. By, default, `Get-History` gets all entries in the session history. If you use both the Count and Id parameters in a command, the display ends with the command that is specified by the Id parameter." }, { "name": "-Id", @@ -197,7 +197,7 @@ }, { "name": "-Count", - "description": "Specifies the number of the most recent history entries that this cmdlet gets. By, default, `Get-History` gets all entries in the session history. If you use both the Count and Id parameters in a command, the display ends with the command that is specified by the Id parameter.\n" + "description": "Specifies the number of the most recent history entries that this cmdlet gets. By, default, `Get-History` gets all entries in the session history. If you use both the Count and Id parameters in a command, the display ends with the command that is specified by the Id parameter." } ], "description": "Gets a list of the commands entered during the current session.", diff --git a/command-signatures/json/autogenerated/powershell/get-hotfix.json b/command-signatures/json/autogenerated/powershell/get-hotfix.json new file mode 100644 index 00000000..ef0cda55 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-hotfix.json @@ -0,0 +1,231 @@ +{ + "name": "Get-HotFix", + "options": [ + { + "name": [ + "-ComputerName", + "-CN", + "-__Server", + "-IPAddress" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies a remote computer. Type the NetBIOS name, an Internet Protocol (IP) address, or a fully qualified domain name (FQDN) of a remote computer." + }, + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to access the computer and run commands. The default is the current user" + }, + { + "name": "-Description", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "`Get-HotFix` uses the Description parameter to specify hotfix types. Wildcards are permitted." + }, + { + "name": [ + "-Id", + "-HFID" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Filters the `Get-HotFix` results for specific hotfix Ids. Wildcards aren't accepted." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Id", + "description": "Filters the `Get-HotFix` results for specific hotfix Ids. Wildcards aren't accepted." + } + ], + "description": "Gets the hotfixes that are installed on local or remote computers.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-installedlanguage.json b/command-signatures/json/autogenerated/powershell/get-installedlanguage.json new file mode 100644 index 00000000..a8bc077a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-installedlanguage.json @@ -0,0 +1,200 @@ +{ + "name": "Get-InstalledLanguage", + "options": [ + { + "name": [ + "-Language", + "-LanguageId", + "-LanguageTag" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Shows the language components that are installed for the specified language." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Language", + "description": "Shows the language components that are installed for the specified language." + } + ], + "description": "Returns information about the installed languages on a device.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-installedpsresource.json b/command-signatures/json/autogenerated/powershell/get-installedpsresource.json index b9e6e6a7..f0ee7dfa 100644 --- a/command-signatures/json/autogenerated/powershell/get-installedpsresource.json +++ b/command-signatures/json/autogenerated/powershell/get-installedpsresource.json @@ -26,10 +26,10 @@ "name": "Microsoft.PowerShell.PSResourceGet.UtilClasses.ScopeType", "suggestions": [ { - "name": "CurrentUser" + "name": "AllUsers" }, { - "name": "AllUsers" + "name": "CurrentUser" } ] } @@ -43,7 +43,7 @@ "name": "System.String" } ], - "description": "Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax.\n" + "description": "Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax." }, { "name": [ @@ -222,7 +222,7 @@ "description": "Name of a resource to find. Wildcards are supported but NuGet only accepts the `*` character. NuGet doesn't support wildcard searches of local (file-based) repositories." } ], - "description": "Returns modules and scripts installed on the machine via PowerShellGet .", + "description": "Returns modules and scripts installed on the machine via PowerShellGet.", "parserDirectives": { "flagsArePosixNoncompliant": true, "flagsMatchUniquePrefix": true, diff --git a/command-signatures/json/autogenerated/powershell/get-item.json b/command-signatures/json/autogenerated/powershell/get-item.json index 68ce711f..f96d955b 100644 --- a/command-signatures/json/autogenerated/powershell/get-item.json +++ b/command-signatures/json/autogenerated/powershell/get-item.json @@ -3,16 +3,16 @@ "options": [ { "name": "-CodeSigningCert", - "description": "This is a dynamic parameter made available by the Certificate provider. This parameter and the Certificate provider are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the Certificate provider. This parameter and the Certificate provider are only available on Windows." }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter isn't supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-DnsName", @@ -21,11 +21,11 @@ "name": "Microsoft.PowerShell.Commands.DnsNameRepresentation" } ], - "description": "This is a dynamic parameter made available by the Certificate provider. This parameter and the Certificate provider are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the Certificate provider. This parameter and the Certificate provider are only available on Windows." }, { "name": "-DocumentEncryptionCert", - "description": "This is a dynamic parameter made available by the Certificate provider. This parameter and the Certificate provider are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the Certificate provider. This parameter and the Certificate provider are only available on Windows." }, { "name": "-Eku", @@ -34,7 +34,7 @@ "name": "System.String" } ], - "description": "This is a dynamic parameter made available by the Certificate provider. This parameter and the Certificate provider are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the Certificate provider. This parameter and the Certificate provider are only available on Windows." }, { "name": "-Exclude", @@ -43,7 +43,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-ExpiringInDays", @@ -52,7 +52,7 @@ "name": "System.Int32" } ], - "description": "This is a dynamic parameter made available by the Certificate provider. This parameter and the Certificate provider are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the Certificate provider. This parameter and the Certificate provider are only available on Windows." }, { "name": "-Filter", @@ -61,11 +61,11 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports filters. Filters are more efficient than other parameters. The provider applies filter when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved. The filter string is passed to the .NET API to enumerate files. The API only supports `*` and `?` wildcards." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports filters. Filters are more efficient than other parameters. The provider applies filter when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved. The filter string is passed to the .NET API to enumerate files. The API only supports `*` and `?` wildcards." }, { "name": "-Force", - "description": "Indicates that this cmdlet gets items that can't otherwise be accessed, such as hidden items. Implementation varies from provider to provider. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md). Even using the Force parameter, the cmdlet can't override security restrictions." + "description": "Indicates that this cmdlet gets items that can't otherwise be accessed, such as hidden items. Implementation varies from provider to provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md). Even using the Force parameter, the cmdlet can't override security restrictions." }, { "name": "-Include", @@ -74,7 +74,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -88,7 +88,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Path", @@ -98,21 +98,20 @@ } ], "isRequired": true, - "description": "Specifies the path to an item. This cmdlet gets the item at the specified location. Wildcard characters are permitted. This parameter is required, but the parameter name Path is optional.\n" + "description": "Specifies the path to an item. This cmdlet gets the item at the specified location. Wildcard characters are permitted. This parameter is required, but the parameter name Path is optional." }, { "name": "-SSLServerAuthentication", - "description": "This is a dynamic parameter made available by the Certificate provider. This parameter and the Certificate provider are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the Certificate provider. This parameter and the Certificate provider are only available on Windows." }, { "name": "-Stream", "args": [ { - "name": "System.String[]", - "default": "No alternate file streams" + "name": "System.String[]" } ], - "description": "This is a dynamic parameter made available by the FileSystem provider. This parameter is only available on Windows.\n" + "description": "This is a dynamic parameter made available by the FileSystem provider. This parameter is only available on Windows." }, { "name": [ @@ -288,7 +287,7 @@ "args": [ { "name": "-Path", - "description": "Specifies the path to an item. This cmdlet gets the item at the specified location. Wildcard characters are permitted. This parameter is required, but the parameter name Path is optional.\n" + "description": "Specifies the path to an item. This cmdlet gets the item at the specified location. Wildcard characters are permitted. This parameter is required, but the parameter name Path is optional." } ], "description": "Gets the item at the specified location.", diff --git a/command-signatures/json/autogenerated/powershell/get-itemproperty.json b/command-signatures/json/autogenerated/powershell/get-itemproperty.json index 0ea7c445..e1b4af7b 100644 --- a/command-signatures/json/autogenerated/powershell/get-itemproperty.json +++ b/command-signatures/json/autogenerated/powershell/get-itemproperty.json @@ -5,10 +5,10 @@ "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. To impersonate another > user, or elevate your credentials when running this cmdlet, use > [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Exclude", @@ -17,7 +17,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -26,7 +26,7 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Include", @@ -35,7 +35,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -49,7 +49,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/get-itempropertyvalue.json b/command-signatures/json/autogenerated/powershell/get-itempropertyvalue.json index 7990f0d0..22937421 100644 --- a/command-signatures/json/autogenerated/powershell/get-itempropertyvalue.json +++ b/command-signatures/json/autogenerated/powershell/get-itempropertyvalue.json @@ -7,7 +7,8 @@ { "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Exclude", @@ -16,7 +17,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -25,7 +26,7 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Include", @@ -34,7 +35,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -48,7 +49,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/get-job.json b/command-signatures/json/autogenerated/powershell/get-job.json index a6524cd7..33341c50 100644 --- a/command-signatures/json/autogenerated/powershell/get-job.json +++ b/command-signatures/json/autogenerated/powershell/get-job.json @@ -8,7 +8,7 @@ "name": "System.DateTime" } ], - "description": "Gets completed jobs that ended after the specified date and time. Enter a DateTime object, such as one returned by the `Get-Date` cmdlet or a string that can be converted to a DateTime object, such as `Dec 1, 2012 2:00 AM` or `11/06`.\n" + "description": "Gets completed jobs that ended after the specified date and time. Enter a DateTime object, such as one returned by the `Get-Date` cmdlet or a string that can be converted to a DateTime object, such as `Dec 1, 2012 2:00 AM` or `11/06`." }, { "name": "-Before", @@ -17,7 +17,7 @@ "name": "System.DateTime" } ], - "description": "Gets completed jobs that ended before the specified date and time. Enter a DateTime object.\n" + "description": "Gets completed jobs that ended before the specified date and time. Enter a DateTime object." }, { "name": "-ChildJobState", @@ -26,42 +26,42 @@ "name": "System.Management.Automation.JobState", "suggestions": [ { - "name": "NotStarted" + "name": "AtBreakpoint" }, { - "name": "Running" + "name": "Blocked" }, { "name": "Completed" }, { - "name": "Failed" + "name": "Disconnected" }, { - "name": "Stopped" + "name": "Failed" }, { - "name": "Blocked" + "name": "NotStarted" }, { - "name": "Suspended" + "name": "Running" }, { - "name": "Disconnected" + "name": "Stopped" }, { - "name": "Suspending" + "name": "Stopping" }, { - "name": "Stopping" + "name": "Suspended" }, { - "name": "AtBreakpoint" + "name": "Suspending" } ] } ], - "description": "Gets only the child jobs that have the specified state. The acceptable values for this parameter are:\n" + "description": "Gets only the child jobs that have the specified state. The acceptable values for this parameter are:" }, { "name": "-Command", @@ -80,7 +80,7 @@ } ], "isRequired": true, - "description": "Specifies a hash table of conditions. This cmdlet gets jobs that satisfy all of the conditions. Enter a hash table where the keys are job properties and the values are job property values.\n" + "description": "Specifies a hash table of conditions. This cmdlet gets jobs that satisfy all of the conditions. Enter a hash table where the keys are job properties and the values are job property values." }, { "name": "-HasMoreData", @@ -89,7 +89,7 @@ "name": "System.Boolean" } ], - "description": "Indicates whether this cmdlet gets only jobs that have the specified HasMoreData property value. The HasMoreData property indicates whether all job results have been received in the current session. To get jobs that have more results, specify a value of `$True`. To get jobs that do not have more results, specify a value of `$False`.\n" + "description": "Indicates whether this cmdlet gets only jobs that have the specified HasMoreData property value. The HasMoreData property indicates whether all job results have been received in the current session. To get jobs that have more results, specify a value of `$true`. To get jobs that do not have more results, specify a value of `$false`." }, { "name": "-Id", @@ -98,11 +98,11 @@ "name": "System.Int32[]" } ], - "description": "Specifies an array of IDs of jobs that this cmdlet gets.\n" + "description": "Specifies an array of IDs of jobs that this cmdlet gets." }, { "name": "-IncludeChildJob", - "description": "Indicates that this cmdlet returns child jobs, in addition to parent jobs.\n" + "description": "Indicates that this cmdlet returns child jobs, in addition to parent jobs." }, { "name": "-InstanceId", @@ -112,7 +112,7 @@ } ], "isRequired": true, - "description": "Specifies an array of instance IDs of jobs that this cmdlet gets. The default is all jobs.\n" + "description": "Specifies an array of instance IDs of jobs that this cmdlet gets. The default is all jobs." }, { "name": "-Name", @@ -131,7 +131,7 @@ "name": "System.Int32" } ], - "description": "Specifies a number of jobs to get. This cmdlet gets the jobs that ended most recently.\n" + "description": "Specifies a number of jobs to get. This cmdlet gets the jobs that ended most recently." }, { "name": "-State", @@ -140,43 +140,43 @@ "name": "System.Management.Automation.JobState", "suggestions": [ { - "name": "NotStarted" + "name": "AtBreakpoint" }, { - "name": "Running" + "name": "Blocked" }, { "name": "Completed" }, { - "name": "Failed" + "name": "Disconnected" }, { - "name": "Stopped" + "name": "Failed" }, { - "name": "Blocked" + "name": "NotStarted" }, { - "name": "Suspended" + "name": "Running" }, { - "name": "Disconnected" + "name": "Stopped" }, { - "name": "Suspending" + "name": "Stopping" }, { - "name": "Stopping" + "name": "Suspended" }, { - "name": "AtBreakpoint" + "name": "Suspending" } ] } ], "isRequired": true, - "description": "Specifies a job state. This cmdlet gets only jobs in the specified state. The acceptable values for this parameter are:\n" + "description": "Specifies a job state. This cmdlet gets only jobs in the specified state. The acceptable values for this parameter are:" }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/get-jobtrigger.json b/command-signatures/json/autogenerated/powershell/get-jobtrigger.json new file mode 100644 index 00000000..08c38aaf --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-jobtrigger.json @@ -0,0 +1,182 @@ +{ + "name": "Get-JobTrigger", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Get-JobTrigger", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-kdsconfiguration.json b/command-signatures/json/autogenerated/powershell/get-kdsconfiguration.json new file mode 100644 index 00000000..722ab0e7 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-kdsconfiguration.json @@ -0,0 +1,182 @@ +{ + "name": "Get-KdsConfiguration", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Retrieves the current configuration of the Microsoft Group KdsSvc from Active Directory.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-kdsrootkey.json b/command-signatures/json/autogenerated/powershell/get-kdsrootkey.json new file mode 100644 index 00000000..f5eb309d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-kdsrootkey.json @@ -0,0 +1,182 @@ +{ + "name": "Get-KdsRootKey", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Retrieves a list of root key values stored by the Microsoft Group KdsSvc.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-lapsadpassword.json b/command-signatures/json/autogenerated/powershell/get-lapsadpassword.json new file mode 100644 index 00000000..d5bf713d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-lapsadpassword.json @@ -0,0 +1,258 @@ +{ + "name": "Get-LapsADPassword", + "options": [ + { + "name": "-AsPlainText", + "description": "Specify this parameter to return the LAPS passwords in clear-text format. The default behavior is to return the LAPS passwords wrapped in a .NET SecureString object." + }, + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a set of credentials to use when querying AD for the LAPS credentials. If not specified, the current user's credentials are used." + }, + { + "name": "-DecryptionCredential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a set of credentials to use when decrypting encrypted LAPS credentials. If not specified, the current user's credentials are used." + }, + { + "name": "-Domain", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the domain to connect to." + }, + { + "name": "-DomainController", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the domain controller to connect to, or the remote server on which an AD Snapshot Browser is running." + }, + { + "name": "-Identity", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the name of the computer or domain controller object to retrieve LAPS credentials from." + }, + { + "name": "-IncludeHistory", + "description": "Specifies that any older LAPS credentials on the computer object should also be displayed." + }, + { + "name": "-Port", + "args": [ + { + "name": "System.Nullable`1[System.Int32]" + } + ], + "isRequired": true, + "description": "Specifies the AD Snapshot Browser port to connect to." + }, + { + "name": "-RecoveryMode", + "isRequired": true, + "description": "This parameter provides a last-ditch option when it's no longer possible to decrypt a given LAPS credential via the normal mechanisms. For example, this might be necessary if a LAPS credential was encrypted against a group that has since been deleted." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Identity", + "description": "Specifies the name of the computer or domain controller object to retrieve LAPS credentials from." + } + ], + "description": "Queries Windows Local Administrator Password Solution (LAPS) credentials from Active Directory (AD) on a specified AD computer or domain controller object.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-localgroup.json b/command-signatures/json/autogenerated/powershell/get-localgroup.json new file mode 100644 index 00000000..a6442781 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-localgroup.json @@ -0,0 +1,204 @@ +{ + "name": "Get-LocalGroup", + "options": [ + { + "name": "-Name", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies an array of names of security groups that this cmdlet gets. You can use the wildcard character." + }, + { + "name": "-SID", + "args": [ + { + "name": "System.Security.Principal.SecurityIdentifier[]" + } + ], + "description": "Specifies an array of security IDs (SIDs) of security groups that this cmdlet gets." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name-Or-SID" + } + ], + "description": "Gets the local security groups.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-localgroupmember.json b/command-signatures/json/autogenerated/powershell/get-localgroupmember.json new file mode 100644 index 00000000..7d5a8555 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-localgroupmember.json @@ -0,0 +1,229 @@ +{ + "name": "Get-LocalGroupMember", + "options": [ + { + "name": "-Group", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.LocalGroup" + } + ], + "isRequired": true, + "description": "Specifies the security group from which this cmdlet gets members." + }, + { + "name": "-Member", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a user or group that this cmdlet gets from a security group. You can specify users or groups by name or security ID (SID). Specify SID strings in S-R-I-S-S . . . format. You can use wildcard characters. If you do not specify this parameter, the cmdlet gets all members of the group." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the security group from which this cmdlet gets members." + }, + { + "name": "-SID", + "args": [ + { + "name": "System.Security.Principal.SecurityIdentifier" + } + ], + "isRequired": true, + "description": "Specifies the security ID of the security group from which this cmdlet gets members." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Group-Or-Name-Or-SID" + }, + { + "name": "-Member", + "description": "Specifies a user or group that this cmdlet gets from a security group. You can specify users or groups by name or security ID (SID). Specify SID strings in S-R-I-S-S . . . format. You can use wildcard characters. If you do not specify this parameter, the cmdlet gets all members of the group." + } + ], + "description": "Gets members from a local group.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-localuser.json b/command-signatures/json/autogenerated/powershell/get-localuser.json new file mode 100644 index 00000000..68dd9656 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-localuser.json @@ -0,0 +1,204 @@ +{ + "name": "Get-LocalUser", + "options": [ + { + "name": "-Name", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies an array of names of user accounts that this cmdlet gets. You can use the wildcard character." + }, + { + "name": "-SID", + "args": [ + { + "name": "System.Security.Principal.SecurityIdentifier[]" + } + ], + "description": "Specifies an array of security IDs (SIDs) of user accounts that this cmdlet gets." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name-Or-SID" + } + ], + "description": "Gets local user accounts.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-location.json b/command-signatures/json/autogenerated/powershell/get-location.json index cbe0f68a..152394e7 100644 --- a/command-signatures/json/autogenerated/powershell/get-location.json +++ b/command-signatures/json/autogenerated/powershell/get-location.json @@ -8,7 +8,7 @@ "name": "System.String[]" } ], - "description": "Gets the current location in the specified PowerShell drive.\n" + "description": "Gets the current location in the specified PowerShell drive." }, { "name": "-PSProvider", @@ -17,11 +17,11 @@ "name": "System.String[]" } ], - "description": "Gets the current location in the drive supported by the specified PowerShell provider. If the specified provider supports more than one drive, this cmdlet returns the location on the most recently accessed drive.\n" + "description": "Gets the current location in the drive supported by the specified PowerShell provider. If the specified provider supports more than one drive, this cmdlet returns the location on the most recently accessed drive." }, { "name": "-Stack", - "description": "Indicates that this cmdlet displays the locations added to the current location stack. You can add locations to stacks by using the `Push-Location` cmdlet.\n" + "description": "Indicates that this cmdlet displays the locations added to the current location stack. You can add locations to stacks by using the `Push-Location` cmdlet." }, { "name": "-StackName", @@ -30,7 +30,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, the named location stacks. Enter one or more location stack names.\n" + "description": "Specifies, as a string array, the named location stacks. Enter one or more location stack names." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/get-member.json b/command-signatures/json/autogenerated/powershell/get-member.json index 3216a8c0..4d6df3fb 100644 --- a/command-signatures/json/autogenerated/powershell/get-member.json +++ b/command-signatures/json/autogenerated/powershell/get-member.json @@ -3,7 +3,7 @@ "options": [ { "name": "-Force", - "description": "Adds the intrinsic members and the compiler-generated get_ and set_ methods to the display. The following list describes the properties that are added when you use the Force parameter:\n" + "description": "Adds the intrinsic members and the compiler-generated get_ and set_ methods to the display. The following list describes the properties that are added when you use the Force parameter:" }, { "name": "-InputObject", @@ -12,7 +12,7 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies the object whose members are retrieved.\n" + "description": "Specifies the object whose members are retrieved." }, { "name": [ @@ -27,54 +27,57 @@ "name": "AliasProperty" }, { - "name": "CodeProperty" + "name": "All" }, { - "name": "Property" + "name": "CodeMethod" }, { - "name": "NoteProperty" + "name": "CodeProperty" }, { - "name": "ScriptProperty" + "name": "Dynamic" }, { - "name": "Properties" + "name": "Event" }, { - "name": "PropertySet" + "name": "InferredProperty" }, { - "name": "Method" + "name": "MemberSet" }, { - "name": "CodeMethod" + "name": "Method" }, { - "name": "ScriptMethod" + "name": "Methods" }, { - "name": "Methods" + "name": "NoteProperty" }, { "name": "ParameterizedProperty" }, { - "name": "MemberSet" + "name": "Properties" }, { - "name": "Event" + "name": "Property" }, { - "name": "Dynamic" + "name": "PropertySet" }, { - "name": "All" + "name": "ScriptMethod" + }, + { + "name": "ScriptProperty" } ] } ], - "description": "Specifies the member type that this cmdlet gets. The default is `All`.\n" + "description": "Specifies the member type that this cmdlet gets. The default is `All`." }, { "name": "-Name", @@ -83,11 +86,11 @@ "name": "System.String[]" } ], - "description": "Specifies the names of one or more properties or methods of the object. `Get-Member` gets only the specified properties and methods.\n" + "description": "Specifies the names of one or more properties or methods of the object. `Get-Member` gets only the specified properties and methods." }, { "name": "-Static", - "description": "Indicates that this cmdlet gets only the static properties and methods of the object. Static properties and methods are defined on the class of objects, not on any particular instance of the class.\n" + "description": "Indicates that this cmdlet gets only the static properties and methods of the object. Static properties and methods are defined on the class of objects, not on any particular instance of the class." }, { "name": "-View", @@ -96,22 +99,21 @@ "name": "System.Management.Automation.PSMemberViewTypes", "suggestions": [ { - "name": "Extended" + "name": "Adapted" }, { - "name": "Adapted" + "name": "All" }, { "name": "Base" }, { - "name": "All" + "name": "Extended" } - ], - "default": "Adapted, Extended" + ] } ], - "description": "Specifies that this cmdlet gets only particular types properties and methods. Specify one or more of the values. The default is Adapted , Extended .\n" + "description": "Specifies that this cmdlet gets only particular types properties and methods. Specify one or more of the values. The default is Adapted, Extended." }, { "name": [ @@ -287,7 +289,7 @@ "args": [ { "name": "-Name", - "description": "Specifies the names of one or more properties or methods of the object. `Get-Member` gets only the specified properties and methods.\n" + "description": "Specifies the names of one or more properties or methods of the object. `Get-Member` gets only the specified properties and methods." } ], "description": "Gets the properties and methods of objects.", diff --git a/command-signatures/json/autogenerated/powershell/get-module.json b/command-signatures/json/autogenerated/powershell/get-module.json index 82e0ce7a..2e8ff112 100644 --- a/command-signatures/json/autogenerated/powershell/get-module.json +++ b/command-signatures/json/autogenerated/powershell/get-module.json @@ -12,7 +12,7 @@ "name": "System.String" } ], - "description": "Specifies the namespace of an alternate CIM provider that exposes CIM modules. The default value is the namespace of the Module Discovery WMI provider.\n" + "description": "Specifies the namespace of an alternate CIM provider that exposes CIM modules. The default value is the namespace of the Module Discovery WMI provider." }, { "name": "-CimResourceUri", @@ -21,7 +21,7 @@ "name": "System.Uri" } ], - "description": "Specifies an alternate location for CIM modules. The default value is the resource URI of the Module Discovery WMI provider on the remote computer.\n" + "description": "Specifies an alternate location for CIM modules. The default value is the resource URI of the Module Discovery WMI provider on the remote computer." }, { "name": "-CimSession", @@ -31,7 +31,7 @@ } ], "isRequired": true, - "description": "Specifies a CIM session on the remote computer. Enter a variable that contains the CIM session or a command that gets the CIM session, such as a Get-CimSession (/powershell/module/cimcmdlets/get-cimsession)command.\n" + "description": "Specifies a CIM session on the remote computer. Enter a variable that contains the CIM session or a command that gets the CIM session, such as a [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) command." }, { "name": "-FullyQualifiedName", @@ -40,11 +40,12 @@ "name": "Microsoft.PowerShell.Commands.ModuleSpecification[]" } ], - "description": "The value can be a module name, a full module specification, or a path to a module file.\n" + "description": "The value can be a module name, a full module specification, or a path to a module file." }, { "name": "-ListAvailable", - "description": "Indicates that this cmdlet gets all installed modules. `Get-Module` gets modules in paths listed in the PSModulePath environment variable. Without this parameter, `Get-Module` gets only the modules that are both listed in the PSModulePath environment variable, and that are loaded in the current session. ListAvailable does not return information about modules that are not found in the PSModulePath environment variable, even if those modules are loaded in the current session." + "isRequired": true, + "description": "By default, `Get-Module` only returns the modules that have been imported into the current session. With this parameter the command lists modules installed in any path included in the `$env:PSModulePath` environment variable." }, { "name": "-Name", @@ -53,7 +54,7 @@ "name": "System.String[]" } ], - "description": "Specifies names or name patterns of modules that this cmdlet gets. Wildcard characters are permitted. You can also pipe the names to `Get-Module`. You cannot specify the FullyQualifiedName parameter in the same command as a Name parameter. Name cannot accept a module GUID as a value. To return modules by specifying a GUID, use FullyQualifiedName instead." + "description": "Specifies names or name patterns of modules that this cmdlet gets. Wildcard characters are permitted. You can also pipe the names to `Get-Module`. You cannot specify the FullyQualifiedName parameter in the same command as a Name parameter." }, { "name": "-PSEdition", @@ -62,7 +63,7 @@ "name": "System.String" } ], - "description": "Gets the modules that support specified edition of PowerShell.\n" + "description": "Gets the modules that support specified edition of PowerShell." }, { "name": "-PSSession", @@ -72,15 +73,15 @@ } ], "isRequired": true, - "description": "Gets the modules in the specified user-managed PowerShell session ( PSSession ). Enter a variable that contains the session, a command that gets the session, such as a `Get-PSSession` command, or a command that creates the session, such as a `New-PSSession` command.\n" + "description": "Gets the modules in the specified user-managed PowerShell session (PSSession). Enter a variable that contains the session, a command that gets the session, such as a `Get-PSSession` command, or a command that creates the session, such as a `New-PSSession` command." }, { "name": "-Refresh", - "description": "Indicates that this cmdlet refreshes the cache of installed commands. The command cache is created when the session starts. It enables the `Get-Command` cmdlet to get commands from modules that are not imported into the session.\n" + "description": "Indicates that this cmdlet refreshes the cache of installed commands. The command cache is created when the session starts. It enables the `Get-Command` cmdlet to get commands from modules that are not imported into the session." }, { "name": "-SkipEditionCheck", - "description": "Skips the check of the CompatiblePSEditions field.\n" + "description": "Skips the check of the CompatiblePSEditions field." }, { "name": [ @@ -256,7 +257,7 @@ "args": [ { "name": "-Name", - "description": "Specifies names or name patterns of modules that this cmdlet gets. Wildcard characters are permitted. You can also pipe the names to `Get-Module`. You cannot specify the FullyQualifiedName parameter in the same command as a Name parameter. Name cannot accept a module GUID as a value. To return modules by specifying a GUID, use FullyQualifiedName instead." + "description": "Specifies names or name patterns of modules that this cmdlet gets. Wildcard characters are permitted. You can also pipe the names to `Get-Module`. You cannot specify the FullyQualifiedName parameter in the same command as a Name parameter." } ], "description": "List the modules imported in the current session or that can be imported from the PSModulePath.", diff --git a/command-signatures/json/autogenerated/powershell/get-nonremovableappspolicy.json b/command-signatures/json/autogenerated/powershell/get-nonremovableappspolicy.json new file mode 100644 index 00000000..ec189a41 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-nonremovableappspolicy.json @@ -0,0 +1,262 @@ +{ + "name": "Get-NonRemovableAppsPolicy", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Returns a list of the app packages that are installed and configured as non-removable apps.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-osconfiguration.json b/command-signatures/json/autogenerated/powershell/get-osconfiguration.json new file mode 100644 index 00000000..dd7e3374 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-osconfiguration.json @@ -0,0 +1,215 @@ +{ + "name": "Get-OSConfiguration", + "options": [ + { + "name": [ + "-FriendlyName", + "-FNAME" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill FriendlyName Description }}" + }, + { + "name": [ + "-SourceId", + "-SID" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill SourceId Description }}" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-SourceId", + "description": "{{ Fill SourceId Description }}" + }, + { + "name": "-FriendlyName", + "description": "{{ Fill FriendlyName Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-osconfigurationdocument.json b/command-signatures/json/autogenerated/powershell/get-osconfigurationdocument.json new file mode 100644 index 00000000..ae1de2df --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-osconfigurationdocument.json @@ -0,0 +1,228 @@ +{ + "name": "Get-OsConfigurationDocument", + "options": [ + { + "name": [ + "-FriendlyName", + "-FNAME" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill FriendlyName Description }}" + }, + { + "name": "-Id", + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill Id Description }}" + }, + { + "name": [ + "-SourceId", + "-SID" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill SourceId Description }}" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Id", + "description": "{{ Fill Id Description }}" + }, + { + "name": "-SourceId", + "description": "{{ Fill SourceId Description }}" + }, + { + "name": "-FriendlyName", + "description": "{{ Fill FriendlyName Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-osconfigurationdocumentcontent.json b/command-signatures/json/autogenerated/powershell/get-osconfigurationdocumentcontent.json new file mode 100644 index 00000000..317d23bf --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-osconfigurationdocumentcontent.json @@ -0,0 +1,229 @@ +{ + "name": "Get-OsConfigurationDocumentContent", + "options": [ + { + "name": [ + "-FriendlyName", + "-FNAME" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill FriendlyName Description }}" + }, + { + "name": "-Id", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": [ + "-SourceId", + "-SID" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill SourceId Description }}" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Id", + "description": "{{ Fill Id Description }}" + }, + { + "name": "-SourceId", + "description": "{{ Fill SourceId Description }}" + }, + { + "name": "-FriendlyName", + "description": "{{ Fill FriendlyName Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-osconfigurationdocumentresult.json b/command-signatures/json/autogenerated/powershell/get-osconfigurationdocumentresult.json new file mode 100644 index 00000000..d3b88938 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-osconfigurationdocumentresult.json @@ -0,0 +1,273 @@ +{ + "name": "Get-OsConfigurationDocumentResult", + "options": [ + { + "name": [ + "-FriendlyName", + "-FNAME" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill FriendlyName Description }}" + }, + { + "name": "-Id", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": [ + "-SourceId", + "-SID" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill SourceId Description }}" + }, + { + "name": [ + "-VerboseOption", + "-VO" + ], + "args": [ + { + "name": "System.String", + "suggestions": [ + { + "name": "Authority" + }, + { + "name": "Authority,Configured" + }, + { + "name": "Configured" + }, + { + "name": "Default" + } + ] + } + ], + "description": "{{ Fill VerboseOption Description }}" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Id", + "description": "{{ Fill Id Description }}" + }, + { + "name": "-SourceId", + "description": "{{ Fill SourceId Description }}" + }, + { + "name": "-FriendlyName", + "description": "{{ Fill FriendlyName Description }}" + }, + { + "name": "-VerboseOption", + "description": "{{ Fill VerboseOption Description }}", + "suggestions": [ + { + "name": "Authority" + }, + { + "name": "Authority,Configured" + }, + { + "name": "Configured" + }, + { + "name": "Default" + } + ] + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-osconfigurationproperty.json b/command-signatures/json/autogenerated/powershell/get-osconfigurationproperty.json new file mode 100644 index 00000000..b15a3547 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-osconfigurationproperty.json @@ -0,0 +1,251 @@ +{ + "name": "Get-OsConfigurationProperty", + "options": [ + { + "name": [ + "-FriendlyName", + "-FNAME" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill FriendlyName Description }}" + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String", + "suggestions": [ + { + "name": "AlwaysRefresh" + }, + { + "name": "DriftControl" + }, + { + "name": "RefreshPeriod" + } + ] + } + ], + "isRequired": true, + "description": "{{ Fill Name Description }}" + }, + { + "name": [ + "-SourceId", + "-SID" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill SourceId Description }}" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "{{ Fill Name Description }}", + "suggestions": [ + { + "name": "AlwaysRefresh" + }, + { + "name": "DriftControl" + }, + { + "name": "RefreshPeriod" + } + ] + }, + { + "name": "-SourceId", + "description": "{{ Fill SourceId Description }}" + }, + { + "name": "-FriendlyName", + "description": "{{ Fill FriendlyName Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-osconfigurationscenariodefinition.json b/command-signatures/json/autogenerated/powershell/get-osconfigurationscenariodefinition.json new file mode 100644 index 00000000..2bd7bcfa --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-osconfigurationscenariodefinition.json @@ -0,0 +1,219 @@ +{ + "name": "Get-OsConfigurationScenarioDefinition", + "options": [ + { + "name": "-Name", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-SchemaVersion", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-Version", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name" + }, + { + "name": "-Version" + }, + { + "name": "-SchemaVersion" + } + ], + "description": "Get-OsConfigurationScenarioDefinition [-Name] [-Version] [-SchemaVersion] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-osconfigurationscenariodefinitioninfo.json b/command-signatures/json/autogenerated/powershell/get-osconfigurationscenariodefinitioninfo.json new file mode 100644 index 00000000..9ea8d553 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-osconfigurationscenariodefinitioninfo.json @@ -0,0 +1,216 @@ +{ + "name": "Get-OsConfigurationScenarioDefinitionInfo", + "options": [ + { + "name": "-Name", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-SchemaVersion", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Version", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name" + }, + { + "name": "-Version" + }, + { + "name": "-SchemaVersion" + } + ], + "description": "Get-OsConfigurationScenarioDefinitionInfo [[-Name] ] [[-Version] ] [[-SchemaVersion] ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-packageprovider.json b/command-signatures/json/autogenerated/powershell/get-packageprovider.json index 947adb85..580af186 100644 --- a/command-signatures/json/autogenerated/powershell/get-packageprovider.json +++ b/command-signatures/json/autogenerated/powershell/get-packageprovider.json @@ -11,7 +11,7 @@ }, { "name": "-ListAvailable", - "description": "Gets all installed providers. `Get-PackageProvider` gets provider in paths listed in the PSModulePath environment variable as well as the package provider assembly folders:\n" + "description": "Gets all installed providers. `Get-PackageProvider` gets provider in paths listed in the PSModulePath environment variable as well as the package provider assembly folders:" }, { "name": "-Name", diff --git a/command-signatures/json/autogenerated/powershell/get-pfxcertificate.json b/command-signatures/json/autogenerated/powershell/get-pfxcertificate.json index d755e688..6171aebc 100644 --- a/command-signatures/json/autogenerated/powershell/get-pfxcertificate.json +++ b/command-signatures/json/autogenerated/powershell/get-pfxcertificate.json @@ -14,7 +14,8 @@ { "name": [ "-LiteralPath", - "-PSPath" + "-PSPath", + "-LP" ], "args": [ { @@ -22,7 +23,7 @@ } ], "isRequired": true, - "description": "The full path to the PFX file of the secured file. Unlike FilePath , the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + "description": "The full path to the PFX file of the secured file. Unlike FilePath, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-NoPromptForPassword", @@ -35,7 +36,7 @@ "name": "System.Security.SecureString" } ], - "description": "Specifies a password required to access a `.pfx` certificate file.\n" + "description": "Specifies a password required to access a `.pfx` certificate file." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/get-pfxdata.json b/command-signatures/json/autogenerated/powershell/get-pfxdata.json new file mode 100644 index 00000000..f54c7a95 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-pfxdata.json @@ -0,0 +1,209 @@ +{ + "name": "Get-PfxData", + "options": [ + { + "name": [ + "-FilePath", + "-FullName" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the path to the PFX file." + }, + { + "name": "-Password", + "args": [ + { + "name": "System.SecureString" + } + ], + "description": "Specifies the password for the imported PFX file." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-FilePath", + "description": "Specifies the path to the PFX file." + } + ], + "description": "Extracts the content of a Personal Information Exchange (PFX) file into a structure without importing it to certificate store.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-pmemdedicatedmemory.json b/command-signatures/json/autogenerated/powershell/get-pmemdedicatedmemory.json new file mode 100644 index 00000000..1c83a096 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-pmemdedicatedmemory.json @@ -0,0 +1,194 @@ +{ + "name": "Get-PmemDedicatedMemory", + "options": [ + { + "name": "-DeviceNumber", + "args": [ + { + "name": "uint32[]" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-DeviceNumber" + } + ], + "description": "Get-PmemDedicatedMemory [] Get-PmemDedicatedMemory [[-DeviceNumber] ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-pmemdisk.json b/command-signatures/json/autogenerated/powershell/get-pmemdisk.json new file mode 100644 index 00000000..a8a08f17 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-pmemdisk.json @@ -0,0 +1,218 @@ +{ + "name": "Get-PmemDisk", + "options": [ + { + "name": "-DiskNumber", + "args": [ + { + "name": "uint32[]" + } + ] + }, + { + "name": "-InputObject", + "args": [ + { + "name": "ciminstance" + } + ] + }, + { + "name": "-PhysicalDevice", + "args": [ + { + "name": "PmemPhysicalDevice" + } + ] + }, + { + "name": "-PhysicalDeviceId", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-DiskNumber" + } + ], + "description": "Get-PmemDisk [] Get-PmemDisk [[-DiskNumber] ] [] Get-PmemDisk [-PhysicalDevice ] [] Get-PmemDisk [-PhysicalDeviceId ] [] Get-PmemDisk [-InputObject ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-pmemphysicaldevice.json b/command-signatures/json/autogenerated/powershell/get-pmemphysicaldevice.json new file mode 100644 index 00000000..d8718d2e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-pmemphysicaldevice.json @@ -0,0 +1,218 @@ +{ + "name": "Get-PmemPhysicalDevice", + "options": [ + { + "name": "-DeviceId", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-DiskNumber", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": "-InputObject", + "args": [ + { + "name": "ciminstance" + } + ] + }, + { + "name": "-LogicalDisk", + "args": [ + { + "name": "PmemDisk" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-DeviceId" + } + ], + "description": "Get-PmemPhysicalDevice [] Get-PmemPhysicalDevice [[-DeviceId] ] [] Get-PmemPhysicalDevice [-LogicalDisk ] [] Get-PmemPhysicalDevice [-DiskNumber ] [] Get-PmemPhysicalDevice [-InputObject ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-pmemunusedregion.json b/command-signatures/json/autogenerated/powershell/get-pmemunusedregion.json new file mode 100644 index 00000000..02ced0a2 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-pmemunusedregion.json @@ -0,0 +1,194 @@ +{ + "name": "Get-PmemUnusedRegion", + "options": [ + { + "name": "-RegionId", + "args": [ + { + "name": "uint32[]" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-RegionId" + } + ], + "description": "Get-PmemUnusedRegion [[-RegionId] ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-process.json b/command-signatures/json/autogenerated/powershell/get-process.json index e8eedc4a..416f28a1 100644 --- a/command-signatures/json/autogenerated/powershell/get-process.json +++ b/command-signatures/json/autogenerated/powershell/get-process.json @@ -7,7 +7,7 @@ "-FV", "-FVI" ], - "description": "Indicates that this cmdlet gets the file version information for the program that runs in the process.\n" + "description": "Indicates that this cmdlet gets the file version information for the program that runs in the process." }, { "name": [ @@ -20,12 +20,12 @@ } ], "isRequired": true, - "description": "Specifies one or more processes by process ID (PID). To specify multiple IDs, use commas to separate the IDs. To find the PID of a process, type `Get-Process`." + "description": "Specifies one or more processes by process ID (PID). You can specify multiple IDs separated by commas. To get the PID of a process, use `Get-Process`. To get the PID of the current PowerShell session, use `$PID`." }, { "name": "-IncludeUserName", "isRequired": true, - "description": "Indicates that the UserName value of the Process object is returned with results of the command." + "description": "Indicates that this command adds a UserName property to each returned Process object." }, { "name": "-InputObject", @@ -35,11 +35,11 @@ } ], "isRequired": true, - "description": "Specifies one or more process objects. Enter a variable that contains the objects, or type a command or expression that gets the objects." + "description": "Specifies one or more Process objects. Use a variable that contains the objects, or a command or expression that gets the objects." }, { "name": "-Module", - "description": "Indicates that this cmdlet gets the modules that have been loaded by the processes.\n" + "description": "Indicates that this cmdlet gets the modules that the process has loaded." }, { "name": [ @@ -52,7 +52,7 @@ "generatorName": "get_process_names" } ], - "description": "Specifies one or more processes by process name. You can type multiple process names (separated by commas) and use wildcard characters. The parameter name (`Name`) is optional." + "description": "Specifies one or more processes by process name. You can specify multiple process names separated by commas and use wildcard characters. Using the `-Name` parameter is optional." }, { "name": [ @@ -228,7 +228,7 @@ "args": [ { "name": "-Name", - "description": "Specifies one or more processes by process name. You can type multiple process names (separated by commas) and use wildcard characters. The parameter name (`Name`) is optional.", + "description": "Specifies one or more processes by process name. You can specify multiple process names separated by commas and use wildcard characters. Using the `-Name` parameter is optional.", "generatorName": "get_process_names" } ], diff --git a/command-signatures/json/autogenerated/powershell/get-processmitigation.json b/command-signatures/json/autogenerated/powershell/get-processmitigation.json new file mode 100644 index 00000000..ba994d9b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-processmitigation.json @@ -0,0 +1,242 @@ +{ + "name": "Get-ProcessMitigation", + "options": [ + { + "name": [ + "-FullPolicy", + "-f" + ], + "description": "Returns every processes' current mitigation settings in the registry" + }, + { + "name": "-Id", + "args": [ + { + "name": "Int32[]" + } + ], + "isRequired": true, + "description": "Process Id to retrieve current running process mitigation settings from" + }, + { + "name": [ + "-Name", + "-n" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "{Current process name to get current running (Or from registry) process mitigation settings from one (Can be more than one instance)" + }, + { + "name": [ + "-RegistryConfigFilePath", + "-o" + ], + "args": [ + { + "name": "String" + } + ], + "description": "File to save the current registry process mitigation configuration to" + }, + { + "name": [ + "-RunningProcesses", + "-r" + ], + "description": "Pull the current process mitigation settings from a running instance instead of the registry." + }, + { + "name": [ + "-System", + "-s" + ], + "description": "Pulls the current system defaults for process mitigations." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Id-Or-Name" + } + ], + "description": "Gets the current process mitigation settings, either from the registry, from a running process, or saves all to a XML.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-provisioningpackage.json b/command-signatures/json/autogenerated/powershell/get-provisioningpackage.json new file mode 100644 index 00000000..c7bc1bc1 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-provisioningpackage.json @@ -0,0 +1,250 @@ +{ + "name": "Get-ProvisioningPackage", + "options": [ + { + "name": [ + "-AllInstalledPackages", + "-All" + ], + "description": "Gets all the installed packages information." + }, + { + "name": [ + "-ConnectedDevice", + "-Device" + ], + "description": "Gets the connected device information." + }, + { + "name": [ + "-LogsDirectoryPath", + "-Logs" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the logs directory path." + }, + { + "name": [ + "-PackageId", + "-Id" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the Id of a package." + }, + { + "name": [ + "-PackagePath", + "-Path" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the package path." + }, + { + "name": [ + "-WprpFile", + "-Wprp" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of a WPR profile file." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-PackageId-Or-PackagePath" + } + ], + "description": "Gets information about the installed provisioning package.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-psbreakpoint.json b/command-signatures/json/autogenerated/powershell/get-psbreakpoint.json index adefcfd8..a6a622fb 100644 --- a/command-signatures/json/autogenerated/powershell/get-psbreakpoint.json +++ b/command-signatures/json/autogenerated/powershell/get-psbreakpoint.json @@ -28,7 +28,7 @@ "name": "Runspace" } ], - "description": "Specifies the Id of a Runspace object so you can interact with breakpoints in the specified runspace.\n" + "description": "Specifies the Id of a Runspace object so you can interact with breakpoints in the specified runspace." }, { "name": "-Script", @@ -43,22 +43,11 @@ "name": "-Type", "args": [ { - "name": "Microsoft.PowerShell.Commands.BreakpointType[]", - "suggestions": [ - { - "name": "Line" - }, - { - "name": "Variable" - }, - { - "name": "Command" - } - ] + "name": "Microsoft.PowerShell.Commands.BreakpointType[]" } ], "isRequired": true, - "description": "Specifies an array of breakpoint types that this cmdlet gets. Enter one or more types. The acceptable values for this parameter are:\n" + "description": "Specifies an array of breakpoint types that this cmdlet gets. Enter one or more types. The acceptable values for this parameter are:" }, { "name": "-Variable", diff --git a/command-signatures/json/autogenerated/powershell/get-psdrive.json b/command-signatures/json/autogenerated/powershell/get-psdrive.json index 61b0e056..d4e1e30c 100644 --- a/command-signatures/json/autogenerated/powershell/get-psdrive.json +++ b/command-signatures/json/autogenerated/powershell/get-psdrive.json @@ -9,7 +9,7 @@ } ], "isRequired": true, - "description": "Specifies the name of the drive.\n" + "description": "Specifies the name of the drive." }, { "name": "-Name", @@ -36,7 +36,7 @@ "name": "System.String" } ], - "description": "Specifies the scope in which this cmdlet gets the drives.\n" + "description": "Specifies the scope in which this cmdlet gets the drives." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/get-psreadlinekeyhandler.json b/command-signatures/json/autogenerated/powershell/get-psreadlinekeyhandler.json index 7827b502..39625be2 100644 --- a/command-signatures/json/autogenerated/powershell/get-psreadlinekeyhandler.json +++ b/command-signatures/json/autogenerated/powershell/get-psreadlinekeyhandler.json @@ -2,8 +2,7 @@ "name": "Get-PSReadLineKeyHandler", "options": [ { - "name": "-Bound", - "description": "Indicates that this cmdlet returns functions that are bound." + "name": "-Bound" }, { "name": [ @@ -12,15 +11,13 @@ ], "args": [ { - "name": "System.String[]" + "name": "string[]" } ], - "isRequired": true, - "description": "Return only functions bound to specific keys or sequences." + "isRequired": true }, { - "name": "-Unbound", - "description": "Indicates that this cmdlet returns functions that are unbound." + "name": "-Unbound" }, { "name": [ @@ -195,11 +192,10 @@ ], "args": [ { - "name": "-Chord", - "description": "Return only functions bound to specific keys or sequences." + "name": "-Chord" } ], - "description": "Gets the key bindings for the PSReadLine module.", + "description": "Get-PSReadLineKeyHandler [-Bound] [-Unbound] [] Get-PSReadLineKeyHandler [-Chord] []", "parserDirectives": { "flagsArePosixNoncompliant": true, "flagsMatchUniquePrefix": true, diff --git a/command-signatures/json/autogenerated/powershell/get-psreadlineoption.json b/command-signatures/json/autogenerated/powershell/get-psreadlineoption.json index 6aae7fbb..c6d6741b 100644 --- a/command-signatures/json/autogenerated/powershell/get-psreadlineoption.json +++ b/command-signatures/json/autogenerated/powershell/get-psreadlineoption.json @@ -173,7 +173,7 @@ } ], "args": [], - "description": "Gets values for the options that can be configured.", + "description": "Get-PSReadLineOption []", "parserDirectives": { "flagsArePosixNoncompliant": true, "flagsMatchUniquePrefix": true, diff --git a/command-signatures/json/autogenerated/powershell/get-pssession.json b/command-signatures/json/autogenerated/powershell/get-pssession.json index f9065fd2..2f2a4395 100644 --- a/command-signatures/json/autogenerated/powershell/get-pssession.json +++ b/command-signatures/json/autogenerated/powershell/get-pssession.json @@ -3,17 +3,16 @@ "options": [ { "name": "-AllowRedirection", - "description": "Indicates that this cmdlet allows redirection of this connection to an alternate Uniform Resource Identifier (URI). By default, PowerShell does not redirect connections.\n" + "description": "Indicates that this cmdlet allows redirection of this connection to an alternate Uniform Resource Identifier (URI). By default, PowerShell does not redirect connections." }, { "name": "-ApplicationName", "args": [ { - "name": "System.String", - "default": "All sessions" + "name": "System.String" } ], - "description": "Specifies the name of an application. This cmdlet connects only to sessions that use the specified application.\n" + "description": "Specifies the name of an application. This cmdlet connects only to sessions that use the specified application." }, { "name": "-Authentication", @@ -22,31 +21,30 @@ "name": "System.Management.Automation.Runspaces.AuthenticationMechanism", "suggestions": [ { - "name": "Default" + "name": "Basic" }, { - "name": "Basic" + "name": "Credssp" }, { - "name": "Negotiate" + "name": "Default" }, { - "name": "NegotiateWithImplicitCredential" + "name": "Digest" }, { - "name": "Credssp" + "name": "Kerberos" }, { - "name": "Digest" + "name": "Negotiate" }, { - "name": "Kerberos" + "name": "NegotiateWithImplicitCredential" } - ], - "default": "Default" + ] } ], - "description": "Specifies the mechanism that is used to authenticate credentials for the session in which the `Get-PSSession` command runs.\n" + "description": "Specifies the mechanism that is used to authenticate credentials for the session in which the `Get-PSSession` command runs." }, { "name": "-CertificateThumbprint", @@ -55,7 +53,7 @@ "name": "System.String" } ], - "description": "Specifies the digital public key certificate (X509) of a user account that has permission to create the session in which the `Get-PSSession` command runs. Enter the certificate thumbprint of the certificate.\n" + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to create the session in which the `Get-PSSession` command runs. Enter the certificate thumbprint of the certificate." }, { "name": [ @@ -68,17 +66,16 @@ } ], "isRequired": true, - "description": "Specifies an array of names of computers. Gets the sessions that connect to the specified computers. Wildcard characters are not permitted. There is no default value.\n" + "description": "Specifies an array of names of computers. Gets the sessions that connect to the specified computers. Wildcard characters are not permitted. There is no default value." }, { "name": "-ConfigurationName", "args": [ { - "name": "System.String", - "default": "All sessions" + "name": "System.String" } ], - "description": "Specifies the name of a configuration. This cmdlet gets only to sessions that use the specified session configuration.\n" + "description": "Specifies the name of a configuration. This cmdlet gets only to sessions that use the specified session configuration." }, { "name": [ @@ -88,12 +85,11 @@ ], "args": [ { - "name": "System.Uri[]", - "default": "Http://localhost:5985/WSMAN" + "name": "System.Uri[]" } ], "isRequired": true, - "description": "Specifies a URI that defines the connection endpoint for the temporary session in which the `Get-PSSession` command runs. The URI must be fully qualified.\n" + "description": "Specifies a URI that defines the connection endpoint for the temporary session in which the `Get-PSSession` command runs. The URI must be fully qualified." }, { "name": "-ContainerId", @@ -103,58 +99,54 @@ } ], "isRequired": true, - "description": "Specifies an array of IDs of containers. This cmdlet starts an interactive session with each of the specified containers. Use the `docker ps` command to get a list of container IDs. For more information, see the help for the docker ps (https://docs.docker.com/engine/reference/commandline/ps/)command." + "description": "Specifies an array of IDs of containers. This cmdlet starts an interactive session with each of the specified containers. Use the `docker ps` command to get a list of container IDs. For more information, see the help for the [docker ps](https://docs.docker.com/engine/reference/commandline/ps/) command." }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user credential. This cmdlet runs the command with the permissions of the specified user. Specify a user account that has permission to connect to the remote computer and run a `Get-PSSession` command. The default is the current user.\n" + "description": "Specifies a user credential. This cmdlet runs the command with the permissions of the specified user. Specify a user account that has permission to connect to the remote computer and run a `Get-PSSession` command. The default is the current user." }, { "name": "-Id", "args": [ { - "name": "System.Int32[]", - "default": "All sessions" + "name": "System.Int32[]" } ], "isRequired": true, - "description": "Specifies an array of session IDs. This cmdlet gets only the sessions with the specified IDs. Type one or more IDs, separated by commas, or use the range operator (`..`) to specify a range of IDs. You cannot use the ID parameter together with the ComputerName parameter.\n" + "description": "Specifies an array of session IDs. This cmdlet gets only the sessions with the specified IDs. Type one or more IDs, separated by commas, or use the range operator (`..`) to specify a range of IDs. You cannot use the Id parameter together with the ComputerName parameter." }, { "name": "-InstanceId", "args": [ { - "name": "System.Guid[]", - "default": "All sessions" + "name": "System.Guid[]" } ], - "description": "Specifies an array of instance IDs of sessions. This cmdlet gets only the sessions with the specified instance IDs.\n" + "isRequired": true, + "description": "Specifies an array of instance IDs of sessions. This cmdlet gets only the sessions with the specified instance IDs." }, { "name": "-Name", "args": [ { - "name": "System.String[]", - "default": "All sessions" + "name": "System.String[]" } ], - "description": "Specifies an array of session names. This cmdlet gets only the sessions that have the specified friendly names. Wildcard characters are permitted.\n" + "description": "Specifies an array of session names. This cmdlet gets only the sessions that have the specified friendly names. Wildcard characters are permitted." }, { "name": "-Port", "args": [ { - "name": "System.Int32", - "default": "5985, 5986" + "name": "System.Int32" } ], - "description": "Specifies the specified network port that is used for the temporary connection in which the `Get-PSSession` command runs. To connect to a remote computer, the remote computer must be listening on the port that the connection uses. The default ports are `5985`, which is the WinRM port for HTTP, and `5986`, which is the WinRM port for HTTPS.\n" + "description": "Specifies the specified network port that is used for the temporary connection in which the `Get-PSSession` command runs. To connect to a remote computer, the remote computer must be listening on the port that the connection uses. The default ports are `5985`, which is the WinRM port for HTTP, and `5986`, which is the WinRM port for HTTPS." }, { "name": "-SessionOption", @@ -163,7 +155,7 @@ "name": "System.Management.Automation.Remoting.PSSessionOption" } ], - "description": "Specifies advanced options for the session. Enter a SessionOption object, such as one that you create by using the `New-PSSessionOption` cmdlet, or a hash table in which the keys are session option names and the values are session option values.\n" + "description": "Specifies advanced options for the session. Enter a SessionOption object, such as one that you create by using the `New-PSSessionOption` cmdlet, or a hash table in which the keys are session option names and the values are session option values." }, { "name": "-State", @@ -175,36 +167,34 @@ "name": "All" }, { - "name": "Opened" + "name": "Broken" }, { - "name": "Disconnected" + "name": "Closed" }, { - "name": "Closed" + "name": "Disconnected" }, { - "name": "Broken" + "name": "Opened" } - ], - "default": "All" + ] } ], - "description": "Specifies a session state. This cmdlet gets only sessions in the specified state. The acceptable values for this parameter are: `All`, `Opened`, `Disconnected`, `Closed`, and `Broken`. The default value is `All`.\n" + "description": "Specifies a session state. This cmdlet gets only sessions in the specified state. The acceptable values for this parameter are: `All`, `Opened`, `Disconnected`, `Closed`, and `Broken`. The default value is `All`." }, { "name": "-ThrottleLimit", "args": [ { - "name": "System.Int32", - "default": "32" + "name": "System.Int32" } ], - "description": "Specifies the maximum number of concurrent connections that can be established to run the `Get-PSSession` command. If you omit this parameter or enter a value of `0` (zero), the default value, `32`, is used. The throttle limit applies only to the current command, not to the session or to the computer.\n" + "description": "Specifies the maximum number of concurrent connections that can be established to run the `Get-PSSession` command. If you omit this parameter or enter a value of `0` (zero), the default value, `32`, is used. The throttle limit applies only to the current command, not to the session or to the computer." }, { "name": "-UseSSL", - "description": "Indicates that this cmdlet uses the Secure Sockets Layer (SSL) protocol to establish the connection in which the `Get-PSSession` command runs. By default, SSL is not used. If you use this parameter, but SSL is not available on the port used for the command, the command fails.\n" + "description": "Indicates that this cmdlet uses the Secure Sockets Layer (SSL) protocol to establish the connection in which the `Get-PSSession` command runs. By default, SSL is not used. If you use this parameter, but SSL is not available on the port used for the command, the command fails." }, { "name": [ @@ -217,7 +207,7 @@ } ], "isRequired": true, - "description": "Specifies an array of ID of virtual machines. This cmdlet starts an interactive session with each of the specified virtual machines. To see the virtual machines that are available to you, use the following command:\n" + "description": "Specifies an array of ID of virtual machines. This cmdlet starts an interactive session with each of the specified virtual machines. To see the virtual machines that are available to you, use the following command:" }, { "name": "-VMName", diff --git a/command-signatures/json/autogenerated/powershell/get-pssessioncapability.json b/command-signatures/json/autogenerated/powershell/get-pssessioncapability.json new file mode 100644 index 00000000..e554120f --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-pssessioncapability.json @@ -0,0 +1,215 @@ +{ + "name": "Get-PSSessionCapability", + "options": [ + { + "name": "-ConfigurationName", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the constrained session configuration (endpoint) that you are inspecting." + }, + { + "name": "-Full", + "description": "Indicates that this cmdlet returns the entire initial session state for the specified user at the specified constrained endpoint." + }, + { + "name": "-Username", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the user whose capabilities you are inspecting." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ConfigurationName", + "description": "Specifies the constrained session configuration (endpoint) that you are inspecting." + }, + { + "name": "-Username", + "description": "Specifies the user whose capabilities you are inspecting." + } + ], + "description": "Gets the capabilities of a specific user on a constrained session configuration.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-pssessionconfiguration.json b/command-signatures/json/autogenerated/powershell/get-pssessionconfiguration.json new file mode 100644 index 00000000..2e9a117c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-pssessionconfiguration.json @@ -0,0 +1,200 @@ +{ + "name": "Get-PSSessionConfiguration", + "options": [ + { + "name": "-Force", + "description": "Suppresses the prompt to restart the WinRM service, if the service is not already running." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Gets only the session configurations with the specified name or name pattern. Enter one or more session configuration names. Wildcards are permitted." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Gets only the session configurations with the specified name or name pattern. Enter one or more session configuration names. Wildcards are permitted." + } + ], + "description": "Gets the registered session configurations on the computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-pssubsystem.json b/command-signatures/json/autogenerated/powershell/get-pssubsystem.json new file mode 100644 index 00000000..bdaf8075 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-pssubsystem.json @@ -0,0 +1,213 @@ +{ + "name": "Get-PSSubsystem", + "options": [ + { + "name": "-Kind", + "args": [ + { + "name": "System.Management.Automation.Subsystem.SubsystemKind", + "suggestions": [ + { + "name": "CommandPredictor" + }, + { + "name": "CrossPlatformDsc" + }, + { + "name": "FeedbackProvider" + } + ] + } + ], + "isRequired": true, + "description": "Specifies the kind of subsystem to be returned. Valid values are: `CommandPredictor`." + }, + { + "name": "-SubsystemType", + "args": [ + { + "name": "System.Type" + } + ], + "isRequired": true, + "description": "Specifies the type of subsystem to be returned." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Retrieves information about the subsystems registered in PowerShell.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-random.json b/command-signatures/json/autogenerated/powershell/get-random.json index bc2e7e80..ea5254fa 100644 --- a/command-signatures/json/autogenerated/powershell/get-random.json +++ b/command-signatures/json/autogenerated/powershell/get-random.json @@ -8,7 +8,7 @@ "name": "System.Int32" } ], - "description": "Specifies the number of random objects to return. The default is 1.\n" + "description": "Specifies the number of random objects to return. The default is 1." }, { "name": "-InputObject", @@ -18,7 +18,7 @@ } ], "isRequired": true, - "description": "Specifies a collection of objects. `Get-Random` gets randomly selected objects in random order from the collection up to the number specified by Count . Enter the objects, a variable that contains the objects, or a command or expression that gets the objects. You can also pipe a collection of objects to `Get-Random`.\n" + "description": "Specifies a collection of objects. `Get-Random` gets randomly selected objects in random order from the collection up to the number specified by Count. Enter the objects, a variable that contains the objects, or a command or expression that gets the objects. You can also pipe a collection of objects to `Get-Random`." }, { "name": "-Maximum", @@ -27,7 +27,7 @@ "name": "System.Object" } ], - "description": "Specifies a maximum value for the random number. `Get-Random` returns a value that's less than the maximum (not equal). Enter an integer, a double-precision floating-point number, or an object that can be converted to an integer or double, such as a numeric string (\"100\").\n" + "description": "Specifies a maximum value for the random number. `Get-Random` returns a value that's less than the maximum (not equal). Enter an integer, a double-precision floating-point number, or an object that can be converted to an integer or double, such as a numeric string (\"100\")." }, { "name": "-Minimum", @@ -36,7 +36,7 @@ "name": "System.Object" } ], - "description": "Specifies a minimum value for the random number. Enter an integer, a double-precision floating-point number, or an object that can be converted to an integer or double, such as a numeric string (\"100\"). The default value is 0 (zero).\n" + "description": "Specifies a minimum value for the random number. Enter an integer, a double-precision floating-point number, or an object that can be converted to an integer or double, such as a numeric string (\"100\"). The default value is 0 (zero)." }, { "name": "-SetSeed", @@ -45,7 +45,7 @@ "name": "System.Nullable`1[System.Int32]" } ], - "description": "Specifies a seed value for the random number generator. When you use SetSeed , the cmdlet generates pseudorandom numbers, which isn't cryptographically secure.\n" + "description": "Specifies a seed value for the random number generator. When you use SetSeed, the cmdlet generates pseudorandom numbers, which isn't cryptographically secure." }, { "name": "-Shuffle", diff --git a/command-signatures/json/autogenerated/powershell/get-refsdedupschedule.json b/command-signatures/json/autogenerated/powershell/get-refsdedupschedule.json new file mode 100644 index 00000000..631a9bf2 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-refsdedupschedule.json @@ -0,0 +1,195 @@ +{ + "name": "Get-ReFSDedupSchedule", + "options": [ + { + "name": "-Volume", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Get-ReFSDedupSchedule [-Volume] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-refsdedupscrubschedule.json b/command-signatures/json/autogenerated/powershell/get-refsdedupscrubschedule.json new file mode 100644 index 00000000..7d9c5895 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-refsdedupscrubschedule.json @@ -0,0 +1,195 @@ +{ + "name": "Get-ReFSDedupScrubSchedule", + "options": [ + { + "name": "-Volume", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Get-ReFSDedupScrubSchedule [-Volume] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-refsdedupstatus.json b/command-signatures/json/autogenerated/powershell/get-refsdedupstatus.json new file mode 100644 index 00000000..9d57e22d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-refsdedupstatus.json @@ -0,0 +1,195 @@ +{ + "name": "Get-ReFSDedupStatus", + "options": [ + { + "name": "-Volume", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Get-ReFSDedupStatus [-Volume] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-scheduledjoboption.json b/command-signatures/json/autogenerated/powershell/get-scheduledjoboption.json new file mode 100644 index 00000000..19ce874f --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-scheduledjoboption.json @@ -0,0 +1,182 @@ +{ + "name": "Get-ScheduledJobOption", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Get-ScheduledJobOption", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-securebootpolicy.json b/command-signatures/json/autogenerated/powershell/get-securebootpolicy.json new file mode 100644 index 00000000..9da31fb8 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-securebootpolicy.json @@ -0,0 +1,182 @@ +{ + "name": "Get-SecureBootPolicy", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets the publisher GUID and the policy version of the Secure Boot configuration policy.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-securebootsvn.json b/command-signatures/json/autogenerated/powershell/get-securebootsvn.json new file mode 100644 index 00000000..0a1cd0a4 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-securebootsvn.json @@ -0,0 +1,193 @@ +{ + "name": "Get-SecureBootSVN", + "options": [ + { + "name": [ + "-BootManagerPath", + "-bm" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Get-SecureBootSVN [-BootManagerPath ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-securebootuefi.json b/command-signatures/json/autogenerated/powershell/get-securebootuefi.json new file mode 100644 index 00000000..2b2b558e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-securebootuefi.json @@ -0,0 +1,288 @@ +{ + "name": "Get-SecureBootUEFI", + "options": [ + { + "name": [ + "-Name", + "-n" + ], + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "db" + }, + { + "name": "dbDefault" + }, + { + "name": "dbt" + }, + { + "name": "dbtDefault" + }, + { + "name": "dbx" + }, + { + "name": "dbxDefault" + }, + { + "name": "KEK" + }, + { + "name": "KEKDefault" + }, + { + "name": "PK" + }, + { + "name": "PKDefault" + }, + { + "name": "SecureBoot" + }, + { + "name": "SetupMode" + } + ] + } + ], + "isRequired": true, + "description": "Specifies the name of the UEFI environment variable." + }, + { + "name": [ + "-OutputFilePath", + "-f" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the output file path of the UEFI environment variable." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the name of the UEFI environment variable.", + "suggestions": [ + { + "name": "db" + }, + { + "name": "dbDefault" + }, + { + "name": "dbt" + }, + { + "name": "dbtDefault" + }, + { + "name": "dbx" + }, + { + "name": "dbxDefault" + }, + { + "name": "KEK" + }, + { + "name": "KEKDefault" + }, + { + "name": "PK" + }, + { + "name": "PKDefault" + }, + { + "name": "SecureBoot" + }, + { + "name": "SetupMode" + } + ] + } + ], + "description": "Gets the UEFI variable values related to Secure Boot.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-securerandom.json b/command-signatures/json/autogenerated/powershell/get-securerandom.json index 2857940c..af7cb263 100644 --- a/command-signatures/json/autogenerated/powershell/get-securerandom.json +++ b/command-signatures/json/autogenerated/powershell/get-securerandom.json @@ -5,38 +5,43 @@ "name": "-Count", "args": [ { - "name": "int" + "name": "System.Int32" } - ] + ], + "description": "Specifies the number of random objects to return. The default is 1." }, { "name": "-InputObject", "args": [ { - "name": "Object[]" + "name": "System.Object[]" } ], - "isRequired": true + "isRequired": true, + "description": "Specifies a collection of objects. `Get-SecureRandom` gets randomly selected objects in random order from the collection up to the number specified by Count. Enter the objects, a variable that contains the objects, or a command or expression that gets the objects. You can also pipe a collection of objects to `Get-SecureRandom`." }, { "name": "-Maximum", "args": [ { - "name": "Object" + "name": "System.Object" } - ] + ], + "description": "Specifies a maximum value for the random number. `Get-SecureRandom` returns a value that's less than the maximum (not equal). Enter an integer, a double-precision floating-point number, or an object that can be converted to an integer or double, such as a numeric string (\"100\")." }, { "name": "-Minimum", "args": [ { - "name": "Object" + "name": "System.Object" } - ] + ], + "description": "Specifies a minimum value for the random number. Enter an integer, a double-precision floating-point number, or an object that can be converted to an integer or double, such as a numeric string (\"100\"). The default value is 0 (zero)." }, { "name": "-Shuffle", - "isRequired": true + "isRequired": true, + "description": "Returns the entire collection in a randomized order." }, { "name": [ @@ -214,7 +219,7 @@ "name": "-InputObject-Or-Maximum" } ], - "description": "\nGet-SecureRandom [[-Maximum] ] [-Minimum ] [-Count ] []\n\nGet-SecureRandom [-InputObject] [-Count ] []\n\nGet-SecureRandom [-InputObject] -Shuffle []\n", + "description": "Gets a random number, or selects objects randomly from a collection.", "parserDirectives": { "flagsArePosixNoncompliant": true, "flagsMatchUniquePrefix": true, diff --git a/command-signatures/json/autogenerated/powershell/get-service.json b/command-signatures/json/autogenerated/powershell/get-service.json new file mode 100644 index 00000000..e22bbc60 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-service.json @@ -0,0 +1,251 @@ +{ + "name": "Get-Service", + "options": [ + { + "name": [ + "-DependentServices", + "-DS" + ], + "description": "Indicates that this cmdlet gets only the services that depend upon the specified service." + }, + { + "name": "-DisplayName", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies, as a string array, the display names of services to be retrieved. Wildcards are permitted." + }, + { + "name": "-Exclude", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies, as a string array, a service or services that this cmdlet excludes from the operation. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as `s*`. Wildcards are permitted." + }, + { + "name": "-Include", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies, as a string array, a service or services that this cmdlet includes in the operation. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as `s*`. Wildcards are permitted." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "System.ServiceProcess.ServiceController[]" + } + ], + "description": "Specifies ServiceController objects representing the services to be retrieved. Enter a variable that contains the objects, or type a command or expression that gets the objects. You can pipe a service object to this cmdlet." + }, + { + "name": [ + "-Name", + "-ServiceName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the service names of services to be retrieved. Wildcards are permitted." + }, + { + "name": [ + "-RequiredServices", + "-SDO", + "-ServicesDependedOn" + ], + "description": "Indicates that this cmdlet gets only the services that this service requires. This parameter gets the value of the ServicesDependedOn property of the service." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the service names of services to be retrieved. Wildcards are permitted." + } + ], + "description": "Gets the services on the computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-systempreferreduilanguage.json b/command-signatures/json/autogenerated/powershell/get-systempreferreduilanguage.json new file mode 100644 index 00000000..563a1b33 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-systempreferreduilanguage.json @@ -0,0 +1,182 @@ +{ + "name": "Get-SystemPreferredUILanguage", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Returns the current System Preferred Language.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-tlsciphersuite.json b/command-signatures/json/autogenerated/powershell/get-tlsciphersuite.json new file mode 100644 index 00000000..18bf1862 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-tlsciphersuite.json @@ -0,0 +1,196 @@ +{ + "name": "Get-TlsCipherSuite", + "options": [ + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the TLS cipher suite to get. The cmdlet gets cipher suites that match the string that this cmdlet specifies, so you can specify a partial name. The name match is case sensitive." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the name of the TLS cipher suite to get. The cmdlet gets cipher suites that match the string that this cmdlet specifies, so you can specify a partial name. The name match is case sensitive." + } + ], + "description": "Gets the TLS cipher suites for a computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-tlsecccurve.json b/command-signatures/json/autogenerated/powershell/get-tlsecccurve.json new file mode 100644 index 00000000..10a06cc8 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-tlsecccurve.json @@ -0,0 +1,196 @@ +{ + "name": "Get-TlsEccCurve", + "options": [ + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the ECC curve to get. The cmdlet gets ECC curves that match the string that this cmdlet specifies, so you can specify a partial name. This parameter is case-sensitive." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the name of the ECC curve to get. The cmdlet gets ECC curves that match the string that this cmdlet specifies, so you can specify a partial name. This parameter is case-sensitive." + } + ], + "description": "Gets the list of Elliptic Curve Cryptography (ECC) cipher suites available for TLS for a computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-tpm.json b/command-signatures/json/autogenerated/powershell/get-tpm.json new file mode 100644 index 00000000..e0cc11d5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-tpm.json @@ -0,0 +1,182 @@ +{ + "name": "Get-Tpm", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets an object that contains information about a TPM.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-tpmendorsementkeyinfo.json b/command-signatures/json/autogenerated/powershell/get-tpmendorsementkeyinfo.json new file mode 100644 index 00000000..73d51be3 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-tpmendorsementkeyinfo.json @@ -0,0 +1,206 @@ +{ + "name": "Get-TpmEndorsementKeyInfo", + "options": [ + { + "name": "-HashAlgorithm", + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "sha256" + } + ] + } + ], + "description": "Specifies the hash algorithm used for the public key. The acceptable values for this parameter are: Sha256." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-HashAlgorithm", + "description": "Specifies the hash algorithm used for the public key. The acceptable values for this parameter are: Sha256.", + "suggestions": [ + { + "name": "sha256" + } + ] + } + ], + "description": "Gets information about the endorsement key and certificates of the TPM.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-tpmsupportedfeature.json b/command-signatures/json/autogenerated/powershell/get-tpmsupportedfeature.json new file mode 100644 index 00000000..d0361d53 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-tpmsupportedfeature.json @@ -0,0 +1,196 @@ +{ + "name": "Get-TpmSupportedFeature", + "options": [ + { + "name": "-FeatureList", + "args": [ + { + "name": "StringCollection" + } + ], + "description": "Specifies feature names as a string collection. The cmdlet verifies the features that you specify. If you specify an empty collection, $Null, or do not include this parameter, the cmdlet verifies all features." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-FeatureList", + "description": "Specifies feature names as a string collection. The cmdlet verifies the features that you specify. If you specify an empty collection, $Null, or do not include this parameter, the cmdlet verifies all features." + } + ], + "description": "Verifies whether a TPM supports specified features.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-transaction.json b/command-signatures/json/autogenerated/powershell/get-transaction.json new file mode 100644 index 00000000..168f12ad --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-transaction.json @@ -0,0 +1,182 @@ +{ + "name": "Get-Transaction", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Get-Transaction []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-troubleshootingpack.json b/command-signatures/json/autogenerated/powershell/get-troubleshootingpack.json new file mode 100644 index 00000000..a2b3d10e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-troubleshootingpack.json @@ -0,0 +1,212 @@ +{ + "name": "Get-TroubleshootingPack", + "options": [ + { + "name": [ + "-AnswerFile", + "-AF" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a path where the cmdlet saves an answer file. You can use an absolute path, a relative path, or a Universal Naming Convention (UNC) path. If you specify this parameter, this cmdlet does not provide output." + }, + { + "name": [ + "-Path", + "-P" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a path to the folder that contains the troubleshooting pack. You can use an absolute path, a relative path, or a Universal Naming Convention (UNC) path." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path", + "description": "Specifies a path to the folder that contains the troubleshooting pack. You can use an absolute path, a relative path, or a Universal Naming Convention (UNC) path." + } + ], + "description": "Gets a troubleshooting pack or generates an answer file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-trustedprovisioningcertificate.json b/command-signatures/json/autogenerated/powershell/get-trustedprovisioningcertificate.json new file mode 100644 index 00000000..069e7f81 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-trustedprovisioningcertificate.json @@ -0,0 +1,230 @@ +{ + "name": "Get-TrustedProvisioningCertificate", + "options": [ + { + "name": [ + "-ConnectedDevice", + "-Device" + ], + "description": "If enabled, specifies that the device type is mobile." + }, + { + "name": [ + "-LogsDirectoryPath", + "-Logs" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the logs directory path." + }, + { + "name": [ + "-Thumbprint", + "-Id" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the thumbprint of the certificate to retrieve." + }, + { + "name": [ + "-WprpFile", + "-Wprp" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location of the WPR profile file." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Thumbprint", + "description": "Specifies the thumbprint of the certificate to retrieve." + } + ], + "description": "Lists all installed trusted provisioning certificates.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-typedata.json b/command-signatures/json/autogenerated/powershell/get-typedata.json index ea25160a..d6d0c957 100644 --- a/command-signatures/json/autogenerated/powershell/get-typedata.json +++ b/command-signatures/json/autogenerated/powershell/get-typedata.json @@ -8,7 +8,7 @@ "name": "System.String[]" } ], - "description": "Specifies type data as an array only for the types with the specified names. By default, `Get-TypeData` gets all types in the session.\n" + "description": "Specifies type data as an array only for the types with the specified names. By default, `Get-TypeData` gets all types in the session." }, { "name": [ @@ -184,7 +184,7 @@ "args": [ { "name": "-TypeName", - "description": "Specifies type data as an array only for the types with the specified names. By default, `Get-TypeData` gets all types in the session.\n" + "description": "Specifies type data as an array only for the types with the specified names. By default, `Get-TypeData` gets all types in the session." } ], "description": "Gets the extended type data in the current session.", diff --git a/command-signatures/json/autogenerated/powershell/get-unique.json b/command-signatures/json/autogenerated/powershell/get-unique.json index b88ce90a..d8478238 100644 --- a/command-signatures/json/autogenerated/powershell/get-unique.json +++ b/command-signatures/json/autogenerated/powershell/get-unique.json @@ -5,6 +5,10 @@ "name": "-AsString", "description": "Indicates that this cmdlet uses the data as a string. Without this parameter, data is treated as an object, so when you submit a collection of objects of the same type to `Get-Unique`, such as a collection of files, it returns just one (the first). You can use this parameter to find the unique values of object properties, such as the file names." }, + { + "name": "-CaseInsensitive", + "description": "By default, `Get-Unique` is case-sensitive. When you use this parameter, the cmdlet uses case-insensitive comparisons." + }, { "name": "-InputObject", "args": [ @@ -12,7 +16,7 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies input for `Get-Unique`. Enter a variable that contains the objects or type a command or expression that gets the objects.\n" + "description": "Specifies input for `Get-Unique`. Enter a variable that contains the objects or type a command or expression that gets the objects." }, { "name": "-OnType", diff --git a/command-signatures/json/autogenerated/powershell/get-variable.json b/command-signatures/json/autogenerated/powershell/get-variable.json index 7cad00e3..84598dfd 100644 --- a/command-signatures/json/autogenerated/powershell/get-variable.json +++ b/command-signatures/json/autogenerated/powershell/get-variable.json @@ -36,7 +36,7 @@ "name": "System.String" } ], - "description": "Specifies the variables in the scope.The acceptable values for this parameter are:\n" + "description": "Specifies the variables in the scope.The acceptable values for this parameter are:" }, { "name": "-ValueOnly", diff --git a/command-signatures/json/autogenerated/powershell/get-verb.json b/command-signatures/json/autogenerated/powershell/get-verb.json index 59716f52..7a8569bc 100644 --- a/command-signatures/json/autogenerated/powershell/get-verb.json +++ b/command-signatures/json/autogenerated/powershell/get-verb.json @@ -28,18 +28,16 @@ { "name": "Security" } - ], - "default": "All groups" + ] } ], - "description": "Gets only the specified groups. Enter the name of a group. Wildcards aren't allowed.\n" + "description": "Gets only the specified groups. Enter the name of a group. Wildcards aren't allowed." }, { "name": "-Verb", "args": [ { - "name": "System.String[]", - "default": "All verbs" + "name": "System.String[]" } ], "description": "Gets only the specified verbs. Enter the name of a verb or a name pattern. Wildcards are allowed." @@ -222,7 +220,7 @@ }, { "name": "-Group", - "description": "Gets only the specified groups. Enter the name of a group. Wildcards aren't allowed.\n", + "description": "Gets only the specified groups. Enter the name of a group. Wildcards aren't allowed.", "suggestions": [ { "name": "Common" diff --git a/command-signatures/json/autogenerated/powershell/get-wheamemorypolicy.json b/command-signatures/json/autogenerated/powershell/get-wheamemorypolicy.json new file mode 100644 index 00000000..d4e41540 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-wheamemorypolicy.json @@ -0,0 +1,194 @@ +{ + "name": "Get-WheaMemoryPolicy", + "options": [ + { + "name": [ + "-ComputerName", + "-CN" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of the remote computer from which to retrieve policy information. If you do not specify a computer name, the command returns the policy of the local computer. The alias for *ComputerName* is cn." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets the WHEA memory policies for a computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-wimbootentry.json b/command-signatures/json/autogenerated/powershell/get-wimbootentry.json new file mode 100644 index 00000000..b5f909e5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-wimbootentry.json @@ -0,0 +1,239 @@ +{ + "name": "Get-WIMBootEntry", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the path to the disk volume of the Windows image file boot (WIMBoot) configuration." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Displays the Windows image file boot (WIMBoot) configuration entries for a specified disk volume.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-winacceptlanguagefromlanguagelistoptout.json b/command-signatures/json/autogenerated/powershell/get-winacceptlanguagefromlanguagelistoptout.json new file mode 100644 index 00000000..b6f225fe --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-winacceptlanguagefromlanguagelistoptout.json @@ -0,0 +1,182 @@ +{ + "name": "Get-WinAcceptLanguageFromLanguageListOptOut", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets the HTTP Accept Language from the Language List opt-out setting for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-winculturefromlanguagelistoptout.json b/command-signatures/json/autogenerated/powershell/get-winculturefromlanguagelistoptout.json new file mode 100644 index 00000000..ae1d310f --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-winculturefromlanguagelistoptout.json @@ -0,0 +1,182 @@ +{ + "name": "Get-WinCultureFromLanguageListOptOut", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets the Culture from the language list opt-out setting for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-windefaultinputmethodoverride.json b/command-signatures/json/autogenerated/powershell/get-windefaultinputmethodoverride.json new file mode 100644 index 00000000..cb1e63aa --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-windefaultinputmethodoverride.json @@ -0,0 +1,182 @@ +{ + "name": "Get-WinDefaultInputMethodOverride", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets the default input method override setting for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-windowscapability.json b/command-signatures/json/autogenerated/powershell/get-windowscapability.json new file mode 100644 index 00000000..ac3b13b4 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-windowscapability.json @@ -0,0 +1,284 @@ +{ + "name": "Get-WindowsCapability", + "options": [ + { + "name": "-LimitAccess", + "description": "Prevents DISM from contacting Windows Update or Windows Server Update for the capability source files." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Name", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the identity of the capability in an operating system image to get." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Indicates that the cmdlet operates on a running operating system on the local host." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-Source", + "args": [ + { + "name": "String[]" + } + ], + "description": "Allows you to check the capabilities that are installable from a location that contains packages used to install capabilities, such as a FOD repository. Multiple Source arguments can be used." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets Windows capabilities for an image or a running operating system.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-windowsdeveloperlicense.json b/command-signatures/json/autogenerated/powershell/get-windowsdeveloperlicense.json new file mode 100644 index 00000000..31110140 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-windowsdeveloperlicense.json @@ -0,0 +1,182 @@ +{ + "name": "Get-WindowsDeveloperLicense", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Provides information about Developer Mode for the current computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-windowsdriver.json b/command-signatures/json/autogenerated/powershell/get-windowsdriver.json new file mode 100644 index 00000000..71b4d451 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-windowsdriver.json @@ -0,0 +1,275 @@ +{ + "name": "Get-WindowsDriver", + "options": [ + { + "name": "-All", + "description": "Displays information about default drivers. If you do not specify this parameter, only third-party drivers and listed." + }, + { + "name": "-Driver", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the .inf file or folder containing the .inf files of the drivers you want detailed information about. When you specify a folder, .inf files that are not valid driver packages are ignored." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Displays information about drivers in a Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-windowsedition.json b/command-signatures/json/autogenerated/powershell/get-windowsedition.json new file mode 100644 index 00000000..e0281df4 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-windowsedition.json @@ -0,0 +1,266 @@ +{ + "name": "Get-WindowsEdition", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-Target", + "description": "Displays a list of Windows editions that an image can be changed to." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets edition information about a Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-windowserrorreporting.json b/command-signatures/json/autogenerated/powershell/get-windowserrorreporting.json new file mode 100644 index 00000000..f354be0b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-windowserrorreporting.json @@ -0,0 +1,182 @@ +{ + "name": "Get-WindowsErrorReporting", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Retrieves the Windows Error Reporting status.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-windowsimage.json b/command-signatures/json/autogenerated/powershell/get-windowsimage.json new file mode 100644 index 00000000..6dde4596 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-windowsimage.json @@ -0,0 +1,264 @@ +{ + "name": "Get-WindowsImage", + "options": [ + { + "name": "-ImagePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location of a WIM or VHD file." + }, + { + "name": "-Index", + "args": [ + { + "name": "UInt32" + } + ], + "isRequired": true, + "description": "Specifies the index number of a Windows image in a WIM or VHD file. For a VHD file, the Index must be 1." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Mounted", + "isRequired": true, + "description": "Gets information, including the mount path, for all images mapped to a directories on the local computer." + }, + { + "name": "-Name", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the name of an image in a WIM or VHD file." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets information about a Windows image in a WIM or VHD file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-windowsimagecontent.json b/command-signatures/json/autogenerated/powershell/get-windowsimagecontent.json new file mode 100644 index 00000000..e93e7aba --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-windowsimagecontent.json @@ -0,0 +1,259 @@ +{ + "name": "Get-WindowsImageContent", + "options": [ + { + "name": "-ImagePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location of a WIM file." + }, + { + "name": "-Index", + "args": [ + { + "name": "UInt32" + } + ], + "isRequired": true, + "description": "Specifies the index number of a Windows image in a WIM or VHD file. For a VHD file, the Index must be 1." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Name", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the name of an image in a WIM file." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Displays a list of the files and folders in a specified image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-windowsoptionalfeature.json b/command-signatures/json/autogenerated/powershell/get-windowsoptionalfeature.json new file mode 100644 index 00000000..1450d5d0 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-windowsoptionalfeature.json @@ -0,0 +1,289 @@ +{ + "name": "Get-WindowsOptionalFeature", + "options": [ + { + "name": "-FeatureName", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of a feature to get detailed information about. Feature names are case sensitive if you are servicing a Windows image other than Windows 8." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-PackageName", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of a package as it is listed in the Windows image. Use the *PackageName* parameter to get all of the features in the package. Use the *FeatureName* and *PackageName* parameters to get more detailed information about a specific feature in the package." + }, + { + "name": "-PackagePath", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location of a .cab file in the Windows image. Use the *PackagePath* parameter to get all of the features in the package. Use the *FeatureName* and *PackagePath* parameters to get more detailed information about a specific feature in the package." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets information about optional features in a Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-windowspackage.json b/command-signatures/json/autogenerated/powershell/get-windowspackage.json new file mode 100644 index 00000000..757a9160 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-windowspackage.json @@ -0,0 +1,280 @@ +{ + "name": "Get-WindowsPackage", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-PackageName", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of a package as it is listed in the Windows image. Use the *PackageName* parameter to get more detailed information about a specific package in the Windows image, such as whether the package can be installed completely offline without booting the image." + }, + { + "name": "-PackagePath", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location of a .cab file in the Windows image. Use the *PackagePath* parameter to get more detailed information about a specific package in the Windows image, such as whether the package can be installed completely offline without booting the image." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets information about packages in a Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-windowsreservedstoragestate.json b/command-signatures/json/autogenerated/powershell/get-windowsreservedstoragestate.json new file mode 100644 index 00000000..64329262 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-windowsreservedstoragestate.json @@ -0,0 +1,229 @@ +{ + "name": "Get-WindowsReservedStorageState", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the output level shown in the logs. The accepted values are as follows: - Errors (or '0') - shows error events. Could be combined with Warnings or WarningsInfo - Warnings (or '1') - shows warning events - WarningsInfo (or '2') - shows information log records" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets the reserved storage state of the image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-windowssearchsetting.json b/command-signatures/json/autogenerated/powershell/get-windowssearchsetting.json new file mode 100644 index 00000000..6d16dc7c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-windowssearchsetting.json @@ -0,0 +1,182 @@ +{ + "name": "Get-WindowsSearchSetting", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets the values of settings for Windows Search.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-winevent.json b/command-signatures/json/autogenerated/powershell/get-winevent.json new file mode 100644 index 00000000..c55563e0 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-winevent.json @@ -0,0 +1,305 @@ +{ + "name": "Get-WinEvent", + "options": [ + { + "name": [ + "-ComputerName", + "-Cn" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the computer that this cmdlet gets events from the event logs. Type the NetBIOS name, an IP address, or the fully qualified domain name (FQDN) of the computer. The default value is the local computer, localhost. This parameter accepts only one computer name at a time." + }, + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to perform this action. The default value is the current user." + }, + { + "name": "-FilterHashtable", + "args": [ + { + "name": "System.Collections.Hashtable[]" + } + ], + "isRequired": true, + "description": "Specifies a query in hash table format to select events from one or more event logs. The query contains a hash table with one or more key/value pairs." + }, + { + "name": "-FilterXml", + "args": [ + { + "name": "System.Xml.XmlDocument" + } + ], + "isRequired": true, + "description": "Specifies a structured XML query that this cmdlet selects events from one or more event logs." + }, + { + "name": "-FilterXPath", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies an XPath query that this cmdlet select events from one or more logs." + }, + { + "name": "-Force", + "description": "Gets debug and analytic logs, in addition to other event logs. The Force parameter is required to get a debug or analytic log when the value of the Name parameter includes wildcard characters." + }, + { + "name": "-ListLog", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the event logs. Enter the event log names in a comma-separated list. Wildcards are permitted. To get all the logs, use the asterisk (`*`) wildcard." + }, + { + "name": "-ListProvider", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the event log providers that this cmdlet gets. An event log provider is a program or service that writes events to the event log." + }, + { + "name": "-LogName", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the event logs that this cmdlet get events from. Enter the event log names in a comma-separated list. Wildcards are permitted. You can also pipe log names to the `Get-WinEvent` cmdlet." + }, + { + "name": "-MaxEvents", + "args": [ + { + "name": "System.Int64" + } + ], + "description": "Specifies the maximum number of events that are returned. Enter an integer such as 100. The default is to return all the events in the logs or files." + }, + { + "name": "-Oldest", + "description": "Indicate that this cmdlet gets the events in oldest-first order. By default, events are returned in newest-first order." + }, + { + "name": [ + "-Path", + "-PSPath" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the path to the event log files that this cmdlet get events from. Enter the paths to the log files in a comma-separated list, or use wildcard characters to create file path patterns." + }, + { + "name": "-ProviderName", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies, as a string array, the event log providers from which this cmdlet gets events. Enter the provider names in a comma-separated list, or use wildcard characters to create provider name patterns." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-FilterHashtable-Or-FilterXml-Or-ListLog-Or-ListProvider-Or-LogName-Or-Path-Or-ProviderName" + } + ], + "description": "Gets events from event logs and event tracing log files on local and remote computers.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-winhomelocation.json b/command-signatures/json/autogenerated/powershell/get-winhomelocation.json new file mode 100644 index 00000000..28a61509 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-winhomelocation.json @@ -0,0 +1,182 @@ +{ + "name": "Get-WinHomeLocation", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets the Windows GeoID home location setting for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-winlanguagebaroption.json b/command-signatures/json/autogenerated/powershell/get-winlanguagebaroption.json new file mode 100644 index 00000000..c70e45ac --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-winlanguagebaroption.json @@ -0,0 +1,182 @@ +{ + "name": "Get-WinLanguageBarOption", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets the language bar mode and language bar type for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-winsystemlocale.json b/command-signatures/json/autogenerated/powershell/get-winsystemlocale.json new file mode 100644 index 00000000..98ab6863 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-winsystemlocale.json @@ -0,0 +1,182 @@ +{ + "name": "Get-WinSystemLocale", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets the System-locale setting for the current computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-winuilanguageoverride.json b/command-signatures/json/autogenerated/powershell/get-winuilanguageoverride.json new file mode 100644 index 00000000..60fade5f --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-winuilanguageoverride.json @@ -0,0 +1,182 @@ +{ + "name": "Get-WinUILanguageOverride", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets the Windows UI language override setting for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-winuserlanguagelist.json b/command-signatures/json/autogenerated/powershell/get-winuserlanguagelist.json new file mode 100644 index 00000000..0c30fc3b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-winuserlanguagelist.json @@ -0,0 +1,182 @@ +{ + "name": "Get-WinUserLanguageList", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets the language list for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-wmiobject.json b/command-signatures/json/autogenerated/powershell/get-wmiobject.json new file mode 100644 index 00000000..95059510 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-wmiobject.json @@ -0,0 +1,353 @@ +{ + "name": "Get-WmiObject", + "options": [ + { + "name": "-Amended" + }, + { + "name": "-AsJob" + }, + { + "name": "-Authentication", + "args": [ + { + "name": "AuthenticationLevel", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "None" + }, + { + "name": "Connect" + }, + { + "name": "Call" + }, + { + "name": "Packet" + }, + { + "name": "PacketIntegrity" + }, + { + "name": "PacketPrivacy" + }, + { + "name": "Unchanged" + } + ] + } + ] + }, + { + "name": "-Authority", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Class", + "-ClassName" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-ComputerName", + "-Cn" + ], + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-Credential", + "args": [ + { + "name": "pscredential" + } + ] + }, + { + "name": "-DirectRead" + }, + { + "name": "-EnableAllPrivileges" + }, + { + "name": "-Filter", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Impersonation", + "args": [ + { + "name": "ImpersonationLevel", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "Anonymous" + }, + { + "name": "Identify" + }, + { + "name": "Impersonate" + }, + { + "name": "Delegate" + } + ] + } + ] + }, + { + "name": "-List" + }, + { + "name": "-Locale", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Namespace", + "-NS" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Property", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-Query", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-Recurse" + }, + { + "name": "-ThrottleLimit", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Class-Or-Property" + } + ], + "description": "Get-WmiObject [-Class] [[-Property] ] [-Filter ] [-Amended] [-DirectRead] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [] Get-WmiObject [[-Class] ] [-Recurse] [-Amended] [-List] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [] Get-WmiObject -Query [-Amended] [-DirectRead] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [] Get-WmiObject [-Amended] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [] Get-WmiObject [-Amended] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-wsmancredssp.json b/command-signatures/json/autogenerated/powershell/get-wsmancredssp.json new file mode 100644 index 00000000..246c45d5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-wsmancredssp.json @@ -0,0 +1,182 @@ +{ + "name": "Get-WSManCredSSP", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Gets the Credential Security Support Provider-related configuration for the client.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/get-wsmaninstance.json b/command-signatures/json/autogenerated/powershell/get-wsmaninstance.json new file mode 100644 index 00000000..706c0840 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/get-wsmaninstance.json @@ -0,0 +1,415 @@ +{ + "name": "Get-WSManInstance", + "options": [ + { + "name": "-ApplicationName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the application name in the connection. The default value of the ApplicationName parameter is WSMAN. The complete identifier for the remote endpoint is in the following format:" + }, + { + "name": "-Associations", + "description": "Indicates that this cmdlet gets association instances, not associated instances. You can use this parameter only when the Dialect parameter has a value of Association." + }, + { + "name": [ + "-Authentication", + "-auth", + "-am" + ], + "args": [ + { + "name": "Microsoft.WSMan.Management.AuthenticationMechanism", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "ClientCertificate" + }, + { + "name": "Credssp" + }, + { + "name": "Default" + }, + { + "name": "Digest" + }, + { + "name": "Kerberos" + }, + { + "name": "Negotiate" + }, + { + "name": "None" + } + ] + } + ], + "description": "Specifies the authentication mechanism to be used at the server. The acceptable values for this parameter are:" + }, + { + "name": [ + "-BasePropertiesOnly", + "-UBPO", + "-Base" + ], + "description": "Indicates that this cmdlet enumerates only the properties that are part of the base class that is specified by the ResourceURI parameter. This parameter has no effect if the Shallow parameter is specified." + }, + { + "name": "-CertificateThumbprint", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to perform this action. Enter the certificate thumbprint of the certificate." + }, + { + "name": [ + "-ComputerName", + "-CN" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the computer against which to run the management operation. The value can be a fully qualified domain name, a NetBIOS name, or an IP address. Use the local computer name, use localhost, or use a dot (`.`) to specify the local computer. The local computer is the default. When the remote computer is in a different domain from the user, you must use a fully qualified domain name must be used. You can pipe a value for this parameter to the cmdlet." + }, + { + "name": [ + "-ConnectionURI", + "-CURI", + "-CU" + ], + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the connection endpoint. The format of this string is as follows:" + }, + { + "name": [ + "-Credential", + "-cred", + "-c" + ], + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to perform this action. The default is the current user. Type a user name, such as User01, Domain01\\User01, or User@Domain.com. Or, enter a PSCredential object, such as one returned by the `Get-Credential` cmdlet. When you type a user name, this cmdlet prompts you for a password." + }, + { + "name": "-Dialect", + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the dialect to use in the filter predicate. This can be any dialect that is supported by the remote service. The following aliases can be used for the dialect URI:" + }, + { + "name": "-Enumerate", + "isRequired": true, + "description": "Indicates that this cmdlet returns all of the instances of a management resource." + }, + { + "name": "-Filter", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the filter expression for the enumeration. If you specify this parameter, you must also specify Dialect." + }, + { + "name": "-Fragment", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a section inside the instance that is to be updated or retrieved for the specified operation. For example, to get the status of a spooler service, specify the following:" + }, + { + "name": [ + "-OptionSet", + "-OS" + ], + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "description": "Specifies a set of switches to a service to modify or refine the nature of the request. These resemble switches used in command-line shells because they are service specific. Any number of options can be specified." + }, + { + "name": "-Port", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies the port to use when the client connects to the WinRM service. When the transport is HTTP, the default port is 80. When the transport is HTTPS, the default port is 443." + }, + { + "name": [ + "-ResourceURI", + "-RURI" + ], + "args": [ + { + "name": "System.Uri" + } + ], + "isRequired": true, + "description": "Specifies the URI of the resource class or instance. The URI identifies a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": [ + "-ReturnType", + "-RT" + ], + "args": [ + { + "name": "System.String", + "suggestions": [ + { + "name": "epr" + }, + { + "name": "object" + }, + { + "name": "objectandepr" + } + ] + } + ], + "description": "Specifies the type of data to be returned. The acceptable values for this parameter are:" + }, + { + "name": "-SelectorSet", + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "description": "Specifies a set of value pairs that are used to select particular management resource instances. The SelectorSet parameter is used when more than one instance of the resource exists. The value of the SelectorSet parameter must be a hash table." + }, + { + "name": [ + "-SessionOption", + "-SO" + ], + "args": [ + { + "name": "Microsoft.WSMan.Management.SessionOption" + } + ], + "description": "Specifies extended options for the WS-Management session. Enter a SessionOption object that you create by using the New-WSManSessionOption cmdlet. For more information about the options that are available, type `Get-Help New-WSManSessionOption`." + }, + { + "name": "-Shallow", + "description": "Indicates that this cmdlet returns only instances of the base class that is specified in the resource URI. If you do not specify this parameter, this cmdlet returns instances of the base class that is specified in the URI and in all its derived classes." + }, + { + "name": [ + "-UseSSL", + "-SSL" + ], + "description": "Specifies that the Secure Sockets Layer (SSL) protocol is used to establish a connection to the remote computer. By default, SSL is not used." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ResourceURI", + "description": "Specifies the URI of the resource class or instance. The URI identifies a specific type of resource, such as disks or processes, on a computer." + } + ], + "description": "Displays management information for a resource instance specified by a Resource URI.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/group-object.json b/command-signatures/json/autogenerated/powershell/group-object.json index eb389d1b..8d045ca0 100644 --- a/command-signatures/json/autogenerated/powershell/group-object.json +++ b/command-signatures/json/autogenerated/powershell/group-object.json @@ -6,7 +6,7 @@ "-AsHashTable", "-AHT" ], - "description": "Indicates that this cmdlet returns the group as a hash table. The keys of the hash table are the property values by which the objects are grouped. The values of the hash table are the objects that have that property value.\n" + "description": "Indicates that this cmdlet returns the group as a hash table. The keys of the hash table are the property values by which the objects are grouped. The values of the hash table are the objects that have that property value." }, { "name": "-AsString", @@ -14,7 +14,7 @@ }, { "name": "-CaseSensitive", - "description": "Indicates that this cmdlet makes the grouping case-sensitive. Without this parameter, the property values of objects in a group might have different cases.\n" + "description": "Indicates that this cmdlet makes the grouping case-sensitive. Without this parameter, the property values of objects in a group might have different cases." }, { "name": "-Culture", @@ -32,7 +32,7 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies the objects to group. Enter a variable that contains the objects, or type a command or expression that gets the objects.\n" + "description": "Specifies the objects to group. Enter a variable that contains the objects, or type a command or expression that gets the objects." }, { "name": "-NoElement", @@ -45,7 +45,7 @@ "name": "System.Object[]" } ], - "description": "Specifies the properties for grouping. The objects are arranged into named groups based on the value of the specified properties. When no property is specified, objects are grouped by their value or the `ToString()` representation of their value. The output is sorted in ascending order by the group names.\n" + "description": "Specifies the properties for grouping. The objects are arranged into named groups based on the value of the specified properties. When no property is specified, objects are grouped by their value or the `ToString()` representation of their value. The output is sorted in ascending order by the group names." }, { "name": [ @@ -221,7 +221,7 @@ "args": [ { "name": "-Property", - "description": "Specifies the properties for grouping. The objects are arranged into named groups based on the value of the specified properties. When no property is specified, objects are grouped by their value or the `ToString()` representation of their value. The output is sorted in ascending order by the group names.\n" + "description": "Specifies the properties for grouping. The objects are arranged into named groups based on the value of the specified properties. When no property is specified, objects are grouped by their value or the `ToString()` representation of their value. The output is sorted in ascending order by the group names." } ], "description": "Groups objects that contain the same value for specified properties.", diff --git a/command-signatures/json/autogenerated/powershell/import-alias.json b/command-signatures/json/autogenerated/powershell/import-alias.json index e77c623b..eafef00d 100644 --- a/command-signatures/json/autogenerated/powershell/import-alias.json +++ b/command-signatures/json/autogenerated/powershell/import-alias.json @@ -1,9 +1,16 @@ { "name": "Import-Alias", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Force", - "description": "Allows the cmdlet to import an alias that is already defined or is read only. You can use the following command to display information about the currently-defined aliases:\n" + "description": "Allows the cmdlet to import an alias that is already defined or is read only. You can use the following command to display information about the currently-defined aliases:" }, { "name": [ @@ -40,14 +47,7 @@ "name": "System.String" } ], - "description": "Specifies the scope into which the aliases are imported. The acceptable values for this parameter are:\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the scope into which the aliases are imported. The acceptable values for this parameter are:" }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/import-bcdstore.json b/command-signatures/json/autogenerated/powershell/import-bcdstore.json new file mode 100644 index 00000000..e3b179ed --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/import-bcdstore.json @@ -0,0 +1,219 @@ +{ + "name": "Import-BcdStore", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": "-NoClean", + "description": "{{ Fill NoClean Description }}" + }, + { + "name": "-Path", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Path Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path", + "description": "{{ Fill Path Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/import-certificate.json b/command-signatures/json/autogenerated/powershell/import-certificate.json new file mode 100644 index 00000000..a1d5110c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/import-certificate.json @@ -0,0 +1,223 @@ +{ + "name": "Import-Certificate", + "options": [ + { + "name": "-CertStoreLocation", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the path to the certificate store where the certificates will be imported. If the path to the certificate store is not specified, then the current store is used. In order to get a list of valid CertStoreLocation values, open PowerShell and run `Get-ChildItem Cert:`." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-FilePath", + "-FullName" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the path to a certificate file to be imported. Acceptable formats include `.sst`, `.p7b`, and `.cert` files. If the file contains multiple certificates, then each certificate will be imported to the destination store. The file must be in `.sst` format to import multiple certificates; otherwise, only the first certificate in the file will be imported." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-FilePath", + "description": "Specifies the path to a certificate file to be imported. Acceptable formats include `.sst`, `.p7b`, and `.cert` files. If the file contains multiple certificates, then each certificate will be imported to the destination store. The file must be in `.sst` format to import multiple certificates; otherwise, only the first certificate in the file will be imported." + } + ], + "description": "Imports one or more certificates into a certificate store.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/import-clixml.json b/command-signatures/json/autogenerated/powershell/import-clixml.json index 279eca60..4f1d9e64 100644 --- a/command-signatures/json/autogenerated/powershell/import-clixml.json +++ b/command-signatures/json/autogenerated/powershell/import-clixml.json @@ -5,15 +5,14 @@ "name": "-First", "args": [ { - "name": "System.UInt64", - "default": "False" + "name": "System.UInt64" } ], "description": "Gets only the specified number of objects. Enter the number of objects to get." }, { "name": "-IncludeTotalCount", - "description": "Reports the total number of objects in the data set followed by the selected objects. If the cmdlet can't determine the total count, it displays Unknown total count . The integer has an Accuracy property that indicates the reliability of the total count value. The value of Accuracy ranges from `0.0` to `1.0` where `0.0` means that the cmdlet couldn't count the objects, `1.0` means that the count is exact, and a value between `0.0` and `1.0` indicates an increasingly reliable estimate." + "description": "Reports the total number of objects in the data set followed by the selected objects. If the cmdlet can't determine the total count, it displays Unknown total count. The integer has an Accuracy property that indicates the reliability of the total count value. The value of Accuracy ranges from `0.0` to `1.0` where `0.0` means that the cmdlet couldn't count the objects, `1.0` means that the count is exact, and a value between `0.0` and `1.0` indicates an increasingly reliable estimate." }, { "name": [ @@ -27,7 +26,7 @@ } ], "isRequired": true, - "description": "Specifies the path to the XML files. Unlike Path , the value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + "description": "Specifies the path to the XML files. Unlike Path, the value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Path", @@ -43,8 +42,7 @@ "name": "-Skip", "args": [ { - "name": "System.UInt64", - "default": "False" + "name": "System.UInt64" } ], "description": "Ignores the specified number of objects and then gets the remaining objects. Enter the number of objects to skip." diff --git a/command-signatures/json/autogenerated/powershell/import-counter.json b/command-signatures/json/autogenerated/powershell/import-counter.json new file mode 100644 index 00000000..0974b14a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/import-counter.json @@ -0,0 +1,242 @@ +{ + "name": "Import-Counter", + "options": [ + { + "name": "-Counter", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-EndTime", + "args": [ + { + "name": "datetime" + } + ] + }, + { + "name": "-ListSet", + "args": [ + { + "name": "string[]" + } + ], + "isRequired": true + }, + { + "name": "-MaxSamples", + "args": [ + { + "name": "long" + } + ] + }, + { + "name": [ + "-Path", + "-PSPath" + ], + "args": [ + { + "name": "string[]" + } + ], + "isRequired": true + }, + { + "name": "-StartTime", + "args": [ + { + "name": "datetime" + } + ] + }, + { + "name": "-Summary" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path" + } + ], + "description": "Import-Counter [-Path] [-StartTime ] [-EndTime ] [-Counter ] [-MaxSamples ] [] Import-Counter [-Path] -ListSet [] Import-Counter [-Path] [-Summary] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/import-csv.json b/command-signatures/json/autogenerated/powershell/import-csv.json index 25e77859..344a62af 100644 --- a/command-signatures/json/autogenerated/powershell/import-csv.json +++ b/command-signatures/json/autogenerated/powershell/import-csv.json @@ -5,11 +5,10 @@ "name": "-Delimiter", "args": [ { - "name": "System.Char", - "default": "comma (,)" + "name": "System.Char" } ], - "description": "Specifies the delimiter that separates the property values in the CSV file. The default is a comma (`,`).\n" + "description": "Specifies the delimiter that separates the property values in the CSV file. The default is a comma (`,`)." }, { "name": "-Encoding", @@ -18,40 +17,42 @@ "name": "System.Text.Encoding", "suggestions": [ { - "name": "ASCII" + "name": "ansi" }, { - "name": "BigEndianUnicode" + "name": "ascii" }, { - "name": "BigEndianUTF32" + "name": "bigendianunicode" }, { - "name": "OEM" + "name": "bigendianutf32" }, { - "name": "Unicode" + "name": "oem" }, { - "name": "UTF7" + "name": "unicode" }, { - "name": "UTF8" + "name": "utf32" }, { - "name": "UTF8BOM" + "name": "utf7" }, { - "name": "UTF8NoBOM" + "name": "utf8" }, { - "name": "UTF32" + "name": "utf8BOM" + }, + { + "name": "utf8NoBOM" } - ], - "default": "UTF8NoBOM" + ] } ], - "description": "Specifies the encoding for the imported CSV file. The default value is `utf8NoBOM`.\n" + "description": "Specifies the encoding for the imported CSV file. The default value is `utf8NoBOM`." }, { "name": "-Header", @@ -60,7 +61,7 @@ "name": "System.String[]" } ], - "description": "Specifies an alternate column header row for the imported file. The column header determines the property names of the objects created by `Import-Csv`.\n" + "description": "Specifies an alternate column header row for the imported file. The column header determines the property names of the objects created by `Import-Csv`." }, { "name": [ @@ -74,7 +75,7 @@ } ], "isRequired": true, - "description": "Specifies the path to the CSV file to import. Unlike Path , the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + "description": "Specifies the path to the CSV file to import. Unlike Path, the value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Path", @@ -269,7 +270,7 @@ }, { "name": "-Delimiter", - "description": "Specifies the delimiter that separates the property values in the CSV file. The default is a comma (`,`).\n" + "description": "Specifies the delimiter that separates the property values in the CSV file. The default is a comma (`,`)." } ], "description": "Creates table-like custom objects from the items in a character-separated value (CSV) file.", diff --git a/command-signatures/json/autogenerated/powershell/import-localizeddata.json b/command-signatures/json/autogenerated/powershell/import-localizeddata.json index 1b315ecb..159589cf 100644 --- a/command-signatures/json/autogenerated/powershell/import-localizeddata.json +++ b/command-signatures/json/autogenerated/powershell/import-localizeddata.json @@ -20,7 +20,7 @@ "name": "System.String" } ], - "description": "Specifies the variable into which the text strings are imported. Enter a variable name without a dollar sign (`$`).\n" + "description": "Specifies the variable into which the text strings are imported. Enter a variable name without a dollar sign (`$`)." }, { "name": "-FileName", @@ -29,7 +29,7 @@ "name": "System.String" } ], - "description": "Specifies the name of the data file (`.psd1)` to be imported. Enter a filename. You can specify a filename that doesn't include its `.psd1` filename extension, or you can specify the filename including the `.psd1` filename extension. Data files should be saved as Unicode or UTF-8.\n" + "description": "Specifies the name of the data file (`.psd1`) to be imported. Enter a filename. You can specify a filename that doesn't include its `.psd1` filename extension, or you can specify the filename including the `.psd1` filename extension. Data files should be saved as Unicode or UTF-8." }, { "name": "-SupportedCommand", @@ -38,7 +38,7 @@ "name": "System.String[]" } ], - "description": "Specifies cmdlets and functions that generate only data.\n" + "description": "Specifies cmdlets and functions that generate only data." }, { "name": "-UICulture", @@ -47,7 +47,7 @@ "name": "System.String" } ], - "description": "Specifies an alternate UI culture. The default is the value of the `$PsUICulture` automatic variable. Enter a UI culture in `-` format, such as `en-US`, `de-DE`, or `ar-SA`.\n" + "description": "Specifies an alternate UI culture. The default is the value of the `$PSUICulture` automatic variable. Enter a UI culture in `-` format, such as `en-US`, `de-DE`, or `ar-SA`." }, { "name": [ @@ -223,11 +223,11 @@ "args": [ { "name": "-BindingVariable", - "description": "Specifies the variable into which the text strings are imported. Enter a variable name without a dollar sign (`$`).\n" + "description": "Specifies the variable into which the text strings are imported. Enter a variable name without a dollar sign (`$`)." }, { "name": "-UICulture", - "description": "Specifies an alternate UI culture. The default is the value of the `$PsUICulture` automatic variable. Enter a UI culture in `-` format, such as `en-US`, `de-DE`, or `ar-SA`.\n" + "description": "Specifies an alternate UI culture. The default is the value of the `$PSUICulture` automatic variable. Enter a UI culture in `-` format, such as `en-US`, `de-DE`, or `ar-SA`." } ], "description": "Imports language-specific data into scripts and functions based on the UI culture that's selected for the operating system.", diff --git a/command-signatures/json/autogenerated/powershell/import-module.json b/command-signatures/json/autogenerated/powershell/import-module.json index 6c3d592a..e016d4c4 100644 --- a/command-signatures/json/autogenerated/powershell/import-module.json +++ b/command-signatures/json/autogenerated/powershell/import-module.json @@ -8,7 +8,7 @@ "name": "System.String[]" } ], - "description": "Specifies the aliases that this cmdlet imports from the module into the current session. Enter a comma-separated list of aliases. Wildcard characters are permitted.\n" + "description": "Specifies the aliases that this cmdlet imports from the module into the current session. Enter a comma-separated list of aliases. Wildcard characters are permitted." }, { "name": [ @@ -20,11 +20,11 @@ "name": "System.Object[]" } ], - "description": "Specifies an array of arguments, or parameter values, that are passed to a script module during the `Import-Module` command. This parameter is valid only when you're importing a script module.\n" + "description": "Specifies an array of arguments, or parameter values, that are passed to a script module during the `Import-Module` command. This parameter is valid only when you're importing a script module." }, { "name": "-AsCustomObject", - "description": "Indicates that this cmdlet returns a custom object with members that represent the imported module members. This parameter is valid only for script modules.\n" + "description": "Indicates that this cmdlet returns a custom object with members that represent the imported module members. This parameter is valid only for script modules." }, { "name": "-Assembly", @@ -34,7 +34,7 @@ } ], "isRequired": true, - "description": "Specifies an array of assembly objects. This cmdlet imports the cmdlets and providers implemented in the specified assembly objects. Enter a variable that contains assembly objects or a command that creates assembly objects. You can also pipe an assembly object to `Import-Module`.\n" + "description": "Specifies an array of assembly objects. This cmdlet imports the cmdlets and providers implemented in the specified assembly objects. Enter a variable that contains assembly objects or a command that creates assembly objects. You can also pipe an assembly object to `Import-Module`." }, { "name": "-CimNamespace", @@ -43,7 +43,7 @@ "name": "System.String" } ], - "description": "Specifies the namespace of an alternate CIM provider that exposes CIM modules. The default value is the namespace of the Module Discovery WMI provider.\n" + "description": "Specifies the namespace of an alternate CIM provider that exposes CIM modules. The default value is the namespace of the Module Discovery WMI provider." }, { "name": "-CimResourceUri", @@ -52,7 +52,7 @@ "name": "System.Uri" } ], - "description": "Specifies an alternate location for CIM modules. The default value is the resource URI of the Module Discovery WMI provider on the remote computer.\n" + "description": "Specifies an alternate location for CIM modules. The default value is the resource URI of the Module Discovery WMI provider on the remote computer." }, { "name": "-CimSession", @@ -62,7 +62,7 @@ } ], "isRequired": true, - "description": "Specifies a CIM session on the remote computer. Enter a variable that contains the CIM session or a command that gets the CIM session, such as a Get-CimSession (../CimCmdlets/Get-CimSession.md)command.\n" + "description": "Specifies a CIM session on the remote computer. Enter a variable that contains the CIM session or a command that gets the CIM session, such as a [Get-CimSession](../CimCmdlets/Get-CimSession.md) command." }, { "name": "-Cmdlet", @@ -71,15 +71,15 @@ "name": "System.String[]" } ], - "description": "Specifies an array of cmdlets that this cmdlet imports from the module into the current session. Wildcard characters are permitted.\n" + "description": "Specifies an array of cmdlets that this cmdlet imports from the module into the current session. Wildcard characters are permitted." }, { "name": "-DisableNameChecking", - "description": "Indicates that this cmdlet suppresses the message that warns you when you import a cmdlet or function whose name includes an unapproved verb or a prohibited character.\n" + "description": "Indicates that this cmdlet suppresses the message that warns you when you import a cmdlet or function whose name includes an unapproved verb or a prohibited character." }, { "name": "-Force", - "description": "This parameter causes a module to be loaded, or reloaded, over top of the current one." + "description": "This parameter causes a module to be loaded, or reloaded, over top of the current one. Some modules load external assemblies. The import fails if you are importing a module that loads a newer version of an assembly. The Force parameter can't override the error. You must start a new session to load the new version." }, { "name": "-FullyQualifiedName", @@ -89,7 +89,7 @@ } ], "isRequired": true, - "description": "The value can be a module name, a full module specification, or a path to a module file.\n" + "description": "The value can be a module name, a full module specification, or a path to a module file." }, { "name": "-Function", @@ -102,7 +102,7 @@ }, { "name": "-Global", - "description": "Indicates that this cmdlet imports modules into the global session state so they're available to all commands in the session.\n" + "description": "Indicates that this cmdlet imports modules into the global session state so they're available to all commands in the session." }, { "name": "-MaximumVersion", @@ -123,7 +123,7 @@ "name": "System.Version" } ], - "description": "Specifies a minimum version. This cmdlet imports only a version of the module that's greater than or equal to the specified value. Use the MinimumVersion parameter name or its alias, Version . If no version qualifies, `Import-Module` generates an error.\n" + "description": "Specifies a minimum version. This cmdlet imports only a version of the module that's greater than or equal to the specified value. Use the MinimumVersion parameter name or its alias, Version. If no version qualifies, `Import-Module` generates an error." }, { "name": "-ModuleInfo", @@ -143,14 +143,14 @@ } ], "isRequired": true, - "description": "Specifies the names of the modules to import. Enter the name of the module or the name of a file in the module, such as a `.psd1`, `.psm1`, `.dll`, or `.ps1` file. File paths are optional. Wildcard characters aren't permitted. You can also pipe module names and filenames to `Import-Module`.\n" + "description": "Specifies the names of the modules to import. Enter the name of the module or the name of a file in the module, such as a `.psd1`, `.psm1`, `.dll`, or `.ps1` file. File paths are optional. Wildcard characters aren't permitted. You can also pipe module names and filenames to `Import-Module`." }, { "name": [ "-NoClobber", "-NoOverwrite" ], - "description": "Prevents importing commands that have the same names as existing commands in the current session. By default, `Import-Module` imports all exported module commands.\n" + "description": "Prevents importing commands that have the same names as existing commands in the current session. By default, `Import-Module` imports all exported module commands." }, { "name": "-PassThru", @@ -163,7 +163,7 @@ "name": "System.String" } ], - "description": "Specifies a prefix that this cmdlet adds to the nouns in the names of imported module members.\n" + "description": "Specifies a prefix that this cmdlet adds to the nouns in the names of imported module members." }, { "name": "-PSSession", @@ -173,7 +173,7 @@ } ], "isRequired": true, - "description": "Specifies a PowerShell user-managed session ( PSSession ) from which this cmdlet imports modules into the current session. Enter a variable that contains a PSSession or a command that gets a PSSession , such as a `Get-PSSession` command.\n" + "description": "Specifies a PowerShell user-managed session (PSSession) from which this cmdlet imports modules into the current session. Enter a variable that contains a PSSession or a command that gets a PSSession, such as a `Get-PSSession` command." }, { "name": "-RequiredVersion", @@ -182,7 +182,7 @@ "name": "System.Version" } ], - "description": "Specifies a version of the module that this cmdlet imports. If the version isn't installed, `Import-Module` generates an error.\n" + "description": "Specifies a version of the module that this cmdlet imports. If the version isn't installed, `Import-Module` generates an error." }, { "name": "-Scope", @@ -191,19 +191,19 @@ "name": "System.String", "suggestions": [ { - "name": "Local" + "name": "Global" }, { - "name": "Global" + "name": "Local" } ] } ], - "description": "Specifies a scope to import the module in.\n" + "description": "Specifies a scope to import the module in." }, { "name": "-SkipEditionCheck", - "description": "Skips the check on the `CompatiblePSEditions` field.\n" + "description": "Skips the check on the `CompatiblePSEditions` field." }, { "name": [ @@ -211,7 +211,7 @@ "-UseWinPS" ], "isRequired": true, - "description": "Loads module using Windows PowerShell Compatibility functionality. See about_Windows_PowerShell_Compatibility (About/about_Windows_PowerShell_Compatibility.md)for more information." + "description": "Loads module using Windows PowerShell Compatibility functionality. See [about_Windows_PowerShell_Compatibility](About/about_Windows_PowerShell_Compatibility.md) for more information." }, { "name": "-Variable", @@ -220,7 +220,7 @@ "name": "System.String[]" } ], - "description": "Specifies an array of variables that this cmdlet imports from the module into the current session. Enter a list of variables. Wildcard characters are permitted.\n" + "description": "Specifies an array of variables that this cmdlet imports from the module into the current session. Enter a list of variables. Wildcard characters are permitted." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/import-pfxcertificate.json b/command-signatures/json/autogenerated/powershell/import-pfxcertificate.json new file mode 100644 index 00000000..4e6109c0 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/import-pfxcertificate.json @@ -0,0 +1,240 @@ +{ + "name": "Import-PfxCertificate", + "options": [ + { + "name": "-CertStoreLocation", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the path of the store to which certificates will be imported. If this parameter is not specified, then the current path is used as the destination store." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Exportable", + "description": "Specifies whether the imported private key can be exported. If this parameter is not specified, then the private key cannot be exported." + }, + { + "name": [ + "-FilePath", + "-FullName" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the path for the PFX file." + }, + { + "name": "-Password", + "args": [ + { + "name": "System.SecureString" + } + ], + "description": "Specifies the password for the imported PFX file in the form of a secure string." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-FilePath", + "description": "Specifies the path for the PFX file." + }, + { + "name": "-CertStoreLocation", + "description": "Specifies the path of the store to which certificates will be imported. If this parameter is not specified, then the current path is used as the destination store." + } + ], + "description": "Imports certificates and private keys from a Personal Information Exchange (PFX) file to the destination store.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/import-powershelldatafile.json b/command-signatures/json/autogenerated/powershell/import-powershelldatafile.json index 29525574..ddc836a3 100644 --- a/command-signatures/json/autogenerated/powershell/import-powershelldatafile.json +++ b/command-signatures/json/autogenerated/powershell/import-powershelldatafile.json @@ -205,7 +205,7 @@ "name": "-LiteralPath-Or-Path" } ], - "description": "Imports values from a `.PSD1` file without invoking its contents.", + "description": "Imports values from a `.psd1` file without invoking its contents.", "parserDirectives": { "flagsArePosixNoncompliant": true, "flagsMatchUniquePrefix": true, diff --git a/command-signatures/json/autogenerated/powershell/import-pssession.json b/command-signatures/json/autogenerated/powershell/import-pssession.json index 67a0acf4..847c1657 100644 --- a/command-signatures/json/autogenerated/powershell/import-pssession.json +++ b/command-signatures/json/autogenerated/powershell/import-pssession.json @@ -3,7 +3,7 @@ "options": [ { "name": "-AllowClobber", - "description": "Indicates that this cmdlet imports the specified commands, even if they have the same names as commands in the current session.\n" + "description": "Indicates that this cmdlet imports the specified commands, even if they have the same names as commands in the current session." }, { "name": [ @@ -15,7 +15,7 @@ "name": "System.Object[]" } ], - "description": "Specifies an array of commands that results from using the specified arguments (parameter values).\n" + "description": "Specifies an array of commands that results from using the specified arguments (parameter values)." }, { "name": "-Certificate", @@ -24,7 +24,7 @@ "name": "System.Security.Cryptography.X509Certificates.X509Certificate2" } ], - "description": "Specifies the client certificate that is used to sign the format files (*.Format.ps1xml) or script module files (.psm1) in the temporary module that `Import-PSSession` creates.\n" + "description": "Specifies the client certificate that is used to sign the format files (*.Format.ps1xml) or script module files (`.psm1`) in the temporary module that `Import-PSSession` creates." }, { "name": [ @@ -36,7 +36,7 @@ "name": "System.String[]" } ], - "description": "Specifies commands with the specified names or name patterns. Wildcards are permitted. Use CommandName or its alias, Name .\n" + "description": "Specifies commands with the specified names or name patterns. Wildcards are permitted. Use CommandName or its alias, Name." }, { "name": [ @@ -51,40 +51,37 @@ "name": "Alias" }, { - "name": "Function" + "name": "All" }, { - "name": "Filter" + "name": "Application" }, { "name": "Cmdlet" }, { - "name": "ExternalScript" - }, - { - "name": "Application" + "name": "Configuration" }, { - "name": "Script" + "name": "ExternalScript" }, { - "name": "Workflow" + "name": "Filter" }, { - "name": "Configuration" + "name": "Function" }, { - "name": "All" + "name": "Script" } ] } ], - "description": "Specifies the type of command objects. The default value is Cmdlet. Use CommandType or its alias, Type . The acceptable values for this parameter are:\n" + "description": "Specifies the type of command objects. The default value is Cmdlet. Use CommandType or its alias, Type. The acceptable values for this parameter are:" }, { "name": "-DisableNameChecking", - "description": "Indicates that this cmdlet suppresses the message that warns you when you import a cmdlet or function whose name includes an unapproved verb or a prohibited character.\n" + "description": "Indicates that this cmdlet suppresses the message that warns you when you import a cmdlet or function whose name includes an unapproved verb or a prohibited character." }, { "name": "-FormatTypeName", @@ -93,7 +90,7 @@ "name": "System.String[]" } ], - "description": "Specifies formatting instructions for the specified Microsoft .NET Framework types. Enter the type names. Wildcards are permitted.\n" + "description": "Specifies formatting instructions for the specified Microsoft .NET Framework types. Enter the type names. Wildcards are permitted." }, { "name": "-FullyQualifiedModule", @@ -102,7 +99,7 @@ "name": "Microsoft.PowerShell.Commands.ModuleSpecification[]" } ], - "description": "The value can be a module name, a full module specification, or a path to a module file.\n" + "description": "The value can be a module name, a full module specification, or a path to a module file." }, { "name": [ @@ -114,7 +111,7 @@ "name": "System.String[]" } ], - "description": "Specifies and array of commands in the Windows PowerShell snap-ins and modules. Enter the snap-in and module names. Wildcards are not permitted.\n" + "description": "Specifies and array of commands in the Windows PowerShell snap-ins and modules. Enter the snap-in and module names. Wildcards are not permitted." }, { "name": "-Prefix", @@ -123,7 +120,7 @@ "name": "System.String" } ], - "description": "Specifies a prefix to the nouns in the names of imported commands.\n" + "description": "Specifies a prefix to the nouns in the names of imported commands." }, { "name": "-Session", @@ -313,11 +310,11 @@ }, { "name": "-CommandName", - "description": "Specifies commands with the specified names or name patterns. Wildcards are permitted. Use CommandName or its alias, Name .\n" + "description": "Specifies commands with the specified names or name patterns. Wildcards are permitted. Use CommandName or its alias, Name." }, { "name": "-FormatTypeName", - "description": "Specifies formatting instructions for the specified Microsoft .NET Framework types. Enter the type names. Wildcards are permitted.\n" + "description": "Specifies formatting instructions for the specified Microsoft .NET Framework types. Enter the type names. Wildcards are permitted." } ], "description": "Imports commands from another session into the current session.", diff --git a/command-signatures/json/autogenerated/powershell/import-startlayout.json b/command-signatures/json/autogenerated/powershell/import-startlayout.json new file mode 100644 index 00000000..3867a210 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/import-startlayout.json @@ -0,0 +1,245 @@ +{ + "name": "Import-StartLayout", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-LayoutLiteralPath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a literal path to a layout file. This parameter does not accept the wildcard character (*). If the path includes an escape character (\\\\), enclose the string in single quotes (')." + }, + { + "name": "-LayoutPath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a path to a layout file." + }, + { + "name": "-MountLiteralPath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the literal path where you mounted the .wim file. This parameter does not accept the wildcard character (*). If the path includes an escape character (\\\\), enclose the string in single quotes (')." + }, + { + "name": "-MountPath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the path where you mounted the .wim file and specifies the local appdata folder for the default user." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-LayoutPath", + "description": "Specifies a path to a layout file." + }, + { + "name": "-MountPath", + "description": "Specifies the path where you mounted the .wim file and specifies the local appdata folder for the default user." + } + ], + "description": "Imports the layout of the Start into a mounted Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/import-tpmownerauth.json b/command-signatures/json/autogenerated/powershell/import-tpmownerauth.json new file mode 100644 index 00000000..f9dacb9a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/import-tpmownerauth.json @@ -0,0 +1,210 @@ +{ + "name": "Import-TpmOwnerAuth", + "options": [ + { + "name": "-File", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a file that contains the current owner authorization value for the TPM. You can use the TPM Management Console to create this file." + }, + { + "name": [ + "-OwnerAuthorization", + "-o" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the current owner authorization value for the TPM." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-OwnerAuthorization", + "description": "Specifies the current owner authorization value for the TPM." + } + ], + "description": "Imports a TPM owner authorization value to the registry.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/initialize-pmemphysicaldevice.json b/command-signatures/json/autogenerated/powershell/initialize-pmemphysicaldevice.json new file mode 100644 index 00000000..9877951c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/initialize-pmemphysicaldevice.json @@ -0,0 +1,206 @@ +{ + "name": "Initialize-PmemPhysicalDevice", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-DeviceId", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-Force" + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Initialize-PmemPhysicalDevice -DeviceId [-Force] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/initialize-tpm.json b/command-signatures/json/autogenerated/powershell/initialize-tpm.json new file mode 100644 index 00000000..70f18365 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/initialize-tpm.json @@ -0,0 +1,196 @@ +{ + "name": "Initialize-Tpm", + "options": [ + { + "name": [ + "-AllowClear", + "-c" + ], + "description": "Indicates that the provisioning process clears the TPM, if necessary, to move the TPM closer to complying with latest Windows standards." + }, + { + "name": [ + "-AllowPhysicalPresence", + "-p" + ], + "description": "Indicates that the provisioning process may send physical presence commands that require a user to be present in order to continue." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Performs part of the provisioning process for a TPM.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/install-language.json b/command-signatures/json/autogenerated/powershell/install-language.json new file mode 100644 index 00000000..ae4eca08 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/install-language.json @@ -0,0 +1,218 @@ +{ + "name": "Install-Language", + "options": [ + { + "name": "-AsJob", + "description": "If specified, this parameter will execute the language installation as an [async PowerShell job](/powershell/module/microsoft.powershell.core/about/about_jobs)." + }, + { + "name": [ + "-CopyToSettings", + "-ApplyToSettings", + "-ApplyToInternationalSettings", + "-CopyToInternationalSettings" + ], + "description": "If specified, this parameter sets the System and Default Device Settings (Windows Display Language, regional and locale formats) to the installed language following the installation." + }, + { + "name": "-ExcludeFeatures", + "description": "If specified, the associated language Features on Demand won't be installed." + }, + { + "name": [ + "-Language", + "-LanguageId", + "-LanguageTag" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "The bcp47 tag of the language that you're installing." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Language", + "description": "The bcp47 tag of the language that you're installing." + } + ], + "description": "Installs a language onto a device.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/install-package.json b/command-signatures/json/autogenerated/powershell/install-package.json index 87516ab4..b346b01b 100644 --- a/command-signatures/json/autogenerated/powershell/install-package.json +++ b/command-signatures/json/autogenerated/powershell/install-package.json @@ -51,7 +51,7 @@ "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to access the computer and run commands. Type a user name, such as User01 , Domain01\\User01 , or enter a PSCredential object, generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted for a password.\n" + "description": "Specifies a user account that has permission to access the computer and run commands. Type a user name, such as User01 , Domain01\\User01 , or enter a PSCredential object, generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted for a password." }, { "name": "-Destination", @@ -134,7 +134,7 @@ ] } ], - "description": "Specifies whether `Install-Package` should find all package types. The acceptable values for this parameter are as follows:\n" + "description": "Specifies whether `Install-Package` should find all package types. The acceptable values for this parameter are as follows:" }, { "name": "-InputObject", @@ -274,7 +274,7 @@ ] } ], - "description": "Specifies the scope for which to install the package. The acceptable values for this parameter are as follows:\n" + "description": "Specifies the scope for which to install the package. The acceptable values for this parameter are as follows:" }, { "name": "-ScriptPublishLocation", @@ -342,7 +342,7 @@ ] } ], - "description": "Specifies whether to search for packages with a module, a script, or both. The acceptable values for this parameter are as follows:\n" + "description": "Specifies whether to search for packages with a module, a script, or both. The acceptable values for this parameter are as follows:" }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/install-packageprovider.json b/command-signatures/json/autogenerated/powershell/install-packageprovider.json index a990284f..3269fc62 100644 --- a/command-signatures/json/autogenerated/powershell/install-packageprovider.json +++ b/command-signatures/json/autogenerated/powershell/install-packageprovider.json @@ -102,7 +102,7 @@ ] } ], - "description": "Specifies the installation scope of the provider. The acceptable values for this parameter are:\n" + "description": "Specifies the installation scope of the provider. The acceptable values for this parameter are:" }, { "name": "-Source", diff --git a/command-signatures/json/autogenerated/powershell/install-provisioningpackage.json b/command-signatures/json/autogenerated/powershell/install-provisioningpackage.json new file mode 100644 index 00000000..d2f80cc5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/install-provisioningpackage.json @@ -0,0 +1,245 @@ +{ + "name": "Install-ProvisioningPackage", + "options": [ + { + "name": [ + "-ConnectedDevice", + "-Device" + ], + "description": "Install package to removable media." + }, + { + "name": [ + "-ForceInstall", + "-Force" + ], + "description": "Force the installation of the package." + }, + { + "name": [ + "-LogsDirectoryPath", + "-Logs" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the logs directory path." + }, + { + "name": [ + "-PackagePath", + "-Path" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Path to provisioning package" + }, + { + "name": [ + "-QuietInstall", + "-Quiet" + ], + "description": "Quietly installs the package without any customer interaction." + }, + { + "name": [ + "-WprpFile", + "-Wprp" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of a WPR profile file." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-PackagePath", + "description": "Path to provisioning package" + } + ], + "description": "Install .PPKG package onto the local machine.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/install-psresource.json b/command-signatures/json/autogenerated/powershell/install-psresource.json index a0b3f8c7..2d3ee64d 100644 --- a/command-signatures/json/autogenerated/powershell/install-psresource.json +++ b/command-signatures/json/autogenerated/powershell/install-psresource.json @@ -9,6 +9,13 @@ "name": "-AuthenticodeCheck", "description": "Validates Authenticode signatures and catalog files on Windows." }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ @@ -62,7 +69,7 @@ }, { "name": "-Reinstall", - "description": "Installs the latest version of a module even if the latest version is already installed. The installed version is overwritten. This allows you to repair a damaged installation of the module.\n" + "description": "Installs the latest version of a module even if the latest version is already installed. The installed version is overwritten. This allows you to repair a damaged installation of the module." }, { "name": "-Repository", @@ -71,7 +78,7 @@ "name": "System.String[]" } ], - "description": "Specifies one or more repository names to search. If not specified, search includes all registered repositories, in priority order (highest first), until a repository is found that contains the package. Repositories are sorted by priority then by name. Lower Priority values have a higher precedence.\n" + "description": "Specifies one or more repository names to search. If not specified, search includes all registered repositories, in priority order (highest first), until a repository is found that contains the package. Repositories are sorted by priority then by name. Lower Priority values have a higher precedence." }, { "name": "-RequiredResource", @@ -81,7 +88,7 @@ } ], "isRequired": true, - "description": "A hashtable or JSON string that specifies resources to install. Wildcard characters aren't allowed. See the NOTES (#notes)section for a description of the file formats." + "description": "A hashtable or JSON string that specifies resources to install. Wildcard characters aren't allowed. See the [NOTES](#notes) section for a description of the file formats." }, { "name": "-RequiredResourceFile", @@ -91,7 +98,7 @@ } ], "isRequired": true, - "description": "Path to a `.psd1` or `.json` that specifies resources to install. Wildcard characters aren't allowed. See the NOTES (#notes)section for a description of the file formats." + "description": "Path to a `.psd1` or `.json` that specifies resources to install. Wildcard characters aren't allowed. See the [NOTES](#notes) section for a description of the file formats." }, { "name": "-Scope", @@ -100,15 +107,15 @@ "name": "Microsoft.PowerShell.PSResourceGet.UtilClasses.ScopeType", "suggestions": [ { - "name": "CurrentUser" + "name": "AllUsers" }, { - "name": "AllUsers" + "name": "CurrentUser" } ] } ], - "description": "Specifies the installation scope. Accepted values are:\n" + "description": "Specifies the installation scope. Accepted values are:" }, { "name": "-SkipDependencyCheck", @@ -134,14 +141,7 @@ "name": "System.String" } ], - "description": "Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/install-trustedprovisioningcertificate.json b/command-signatures/json/autogenerated/powershell/install-trustedprovisioningcertificate.json new file mode 100644 index 00000000..d1686a2a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/install-trustedprovisioningcertificate.json @@ -0,0 +1,238 @@ +{ + "name": "Install-TrustedProvisioningCertificate", + "options": [ + { + "name": [ + "-CertificatePath", + "-Path" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Path to .CER file" + }, + { + "name": [ + "-ConnectedDevice", + "-Device" + ], + "description": "If enabled, specifies that the device type is mobile." + }, + { + "name": [ + "-ForceInstall", + "-Force" + ], + "description": "Specifies whether, if certificate already exists, it will be overwritten." + }, + { + "name": [ + "-LogsDirectoryPath", + "-Logs" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the logs directory path." + }, + { + "name": [ + "-WprpFile", + "-Wprp" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location of the WPR profile file." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-CertificatePath", + "description": "Path to .CER file" + } + ], + "description": "Adds a certificate to the Trusted Certificate Store.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/invoke-cimmethod.json b/command-signatures/json/autogenerated/powershell/invoke-cimmethod.json new file mode 100644 index 00000000..26cd105f --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/invoke-cimmethod.json @@ -0,0 +1,338 @@ +{ + "name": "Invoke-CimMethod", + "options": [ + { + "name": "-Arguments", + "args": [ + { + "name": "System.Collections.IDictionary" + } + ], + "description": "Specifies the parameters to pass to the called method. Specify the values for this parameter as name-value pairs, stored in a hash table. The order of the values entered isn't important." + }, + { + "name": "-CimClass", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimClass" + } + ], + "isRequired": true, + "description": "Specifies a CIM class object that represents a CIM class definition on the server. Use this parameter when invoking a static method of a class." + }, + { + "name": "-CimSession", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimSession[]" + } + ], + "isRequired": true, + "description": "Runs the command using the specified CIM session. Enter a variable that contains the CIM session, or a command that creates or gets the CIM session, such as the `New-CimSession` or `Get-CimSession` cmdlets. For more information, see [about_CimSession](../Microsoft.PowerShell.Core/About/about_CimSession.md)." + }, + { + "name": [ + "-ClassName", + "-Class" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the CIM class for which to perform the operation. This parameter is only used for static methods. You can use tab completion to browse the list of classes, because PowerShell gets a list of classes from the local WMI server to provide a list of class names." + }, + { + "name": [ + "-ComputerName", + "-CN", + "-ServerName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the name of the computer on which you want to run the CIM operation. You can specify a fully qualified domain name (FQDN), a NetBIOS name, or an IP address." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-InputObject", + "-CimInstance" + ], + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimInstance" + } + ], + "isRequired": true, + "description": "Specifies a CIM instance object to use as input to invoke a method. This parameter can only be used to invoke instance methods. To invoke class static methods, use the Class parameter or the CimClass parameter." + }, + { + "name": [ + "-MethodName", + "-Name" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the CIM method to invoke. This parameter is mandatory and cannot be null or empty. To invoke static method of a CIM class use the ClassName or the CimClass parameter." + }, + { + "name": "-Namespace", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the namespace for the CIM operation. The default namespace is root/CIMV2. You can use tab completion to browse the list of namespaces, because PowerShell gets a list of namespaces from the local WMI server to provide the list of namespaces." + }, + { + "name": [ + "-OperationTimeoutSec", + "-OT" + ], + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "Specifies the amount of time that the cmdlet waits for a response from the computer. By default, the value is 0, which means that the cmdlet uses the default timeout value for the server." + }, + { + "name": "-Query", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies a query to run on the CIM server. A method is invoked on the instances received as a result of the query. You can specify the query dialect using the QueryDialect parameter." + }, + { + "name": "-QueryDialect", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the query language used for the Query parameter. The acceptable values for this parameter are: WQL or CQL." + }, + { + "name": "-ResourceUri", + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the resource uniform resource identifier (URI) of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-CimClass-Or-ClassName-Or-InputObject" + }, + { + "name": "-Arguments", + "description": "Specifies the parameters to pass to the called method. Specify the values for this parameter as name-value pairs, stored in a hash table. The order of the values entered isn't important." + }, + { + "name": "-MethodName", + "description": "Specifies the name of the CIM method to invoke. This parameter is mandatory and cannot be null or empty. To invoke static method of a CIM class use the ClassName or the CimClass parameter." + } + ], + "description": "Invokes a method of a CIM class.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/invoke-command.json b/command-signatures/json/autogenerated/powershell/invoke-command.json index c09c05e3..834fdd54 100644 --- a/command-signatures/json/autogenerated/powershell/invoke-command.json +++ b/command-signatures/json/autogenerated/powershell/invoke-command.json @@ -3,17 +3,16 @@ "options": [ { "name": "-AllowRedirection", - "description": "Allows redirection of this connection to an alternate Uniform Resource Identifier (URI).\n" + "description": "Allows redirection of this connection to an alternate Uniform Resource Identifier (URI)." }, { "name": "-ApplicationName", "args": [ { - "name": "System.String", - "default": "$PSSessionApplicationName if set on the local computer, otherwise WSMAN" + "name": "System.String" } ], - "description": "Specifies the application name segment of the connection URI. Use this parameter to specify the application name when you aren't using the ConnectionURI parameter in the command.\n" + "description": "Specifies the application name segment of the connection URI. Use this parameter to specify the application name when you aren't using the ConnectionURI parameter in the command." }, { "name": [ @@ -25,11 +24,11 @@ "name": "System.Object[]" } ], - "description": "Supplies the values of parameters for the scriptblock. The parameters in the script block are passed by position from the array value supplied to ArgumentList . This is known as array splatting. For more information about the behavior of ArgumentList , see about_Splatting (about/about_Splatting.md#splatting-with-arrays)." + "description": "Supplies the values of parameters for the scriptblock. The parameters in the scriptblock are passed by position from the array value supplied to ArgumentList. This is known as array splatting. For more information about the behavior of ArgumentList, see [about_Splatting](about/about_Splatting.md#splatting-with-arrays)." }, { "name": "-AsJob", - "description": "Indicates that this cmdlet runs the command as a background job on a remote computer. Use this parameter to run commands that take an extensive time to finish.\n" + "description": "Indicates that this cmdlet runs the command as a background job on a remote computer. Use this parameter to run commands that take an extensive time to finish." }, { "name": "-Authentication", @@ -41,10 +40,10 @@ "name": "Basic" }, { - "name": "Default" + "name": "Credssp" }, { - "name": "Credssp" + "name": "Default" }, { "name": "Digest" @@ -58,11 +57,10 @@ { "name": "NegotiateWithImplicitCredential" } - ], - "default": "Default" + ] } ], - "description": "Specifies the mechanism that's used to authenticate the user's credentials. CredSSP authentication is available only in Windows Vista, Windows Server 2008, and later versions of the Windows operating system.\n" + "description": "Specifies the mechanism that's used to authenticate the user's credentials. CredSSP authentication is available only in Windows Vista, Windows Server 2008, and later versions of the Windows operating system." }, { "name": "-CertificateThumbprint", @@ -71,7 +69,7 @@ "name": "System.String" } ], - "description": "Specifies the digital public key certificate (X509) of a user account that has permission to connect to the disconnected session. Enter the certificate thumbprint of the certificate.\n" + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to connect to the disconnected session. Enter the certificate thumbprint of the certificate." }, { "name": [ @@ -80,31 +78,28 @@ ], "args": [ { - "name": "System.String[]", - "default": "Local computer" + "name": "System.String[]" } ], - "description": "Specifies the computers on which the command runs. The default is the local computer.\n" + "description": "Specifies the computers on which the command runs. The default is the local computer." }, { "name": "-ConfigurationName", "args": [ { - "name": "System.String", - "default": "$PSSessionConfigurationName if set on the local computer, otherwise Microsoft.PowerShell" + "name": "System.String" } ], - "description": "Specifies the session configuration that is used for the new PSSession .\n" + "description": "Specifies the session configuration that is used for the new PSSession." }, { "name": "-ConnectingTimeout", "args": [ { - "name": "System.Int32", - "default": "Unlimited" + "name": "System.Int32" } ], - "description": "Specifies the amount of time in milliseconds allowed for the initial SSH connection to complete. If the connection doesn't complete within the specified time, an error is returned.\n" + "description": "Specifies the amount of time in milliseconds allowed for the initial SSH connection to complete. If the connection doesn't complete within the specified time, an error is returned." }, { "name": [ @@ -114,11 +109,10 @@ ], "args": [ { - "name": "System.Uri[]", - "default": "http://localhost:5985/WSMAN" + "name": "System.Uri[]" } ], - "description": "Specifies a Uniform Resource Identifier (URI) that defines the connection endpoint of the session. The URI must be fully qualified.\n" + "description": "Specifies a Uniform Resource Identifier (URI) that defines the connection endpoint of the session. The URI must be fully qualified." }, { "name": "-ContainerId", @@ -134,15 +128,15 @@ "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to perform this action. The default is the current user.\n" + "isRequired": true, + "description": "Specifies a user account that has permission to perform this action. The default is the current user." }, { "name": "-EnableNetworkAccess", - "description": "Indicates that this cmdlet adds an interactive security token to loopback sessions. The interactive token lets you run commands in the loopback session that get data from other computers. For example, you can run a command in the session that copies XML files from a remote computer to the local computer.\n" + "description": "Indicates that this cmdlet adds an interactive security token to loopback sessions. The interactive token lets you run commands in the loopback session that get data from other computers. For example, you can run a command in the session that copies XML files from a remote computer to the local computer." }, { "name": [ @@ -155,14 +149,14 @@ } ], "isRequired": true, - "description": "Specifies a local script that this cmdlet runs on one or more remote computers. Enter the path and filename of the script, or pipe a script path to `Invoke-Command`. The script must exist on the local computer or in a directory that the local computer can access. Use ArgumentList to specify the values of parameters in the script.\n" + "description": "Specifies a local script that this cmdlet runs on one or more remote computers. Enter the path and filename of the script, or pipe a script path to `Invoke-Command`. The script must exist on the local computer or in a directory that the local computer can access. Use ArgumentList to specify the values of parameters in the script." }, { "name": [ "-HideComputerName", "-HCN" ], - "description": "Indicates that this cmdlet omits the computer name of each object from the output display. By default, the name of the computer that generated the object appears in the display.\n" + "description": "Indicates that this cmdlet omits the computer name of each object from the output display. By default, the name of the computer that generated the object appears in the display." }, { "name": "-HostName", @@ -172,14 +166,14 @@ } ], "isRequired": true, - "description": "Specifies an array of computer names for a Secure Shell (SSH) based connection. This is similar to the ComputerName parameter except that the connection to the remote computer is made using SSH rather than Windows WinRM.\n" + "description": "Specifies an array of computer names for a Secure Shell (SSH) based connection. This is similar to the ComputerName parameter except that the connection to the remote computer is made using SSH rather than Windows WinRM." }, { "name": [ "-InDisconnectedSession", "-Disconnected" ], - "description": "Indicates that this cmdlet runs a command or script in a disconnected session.\n" + "description": "Indicates that this cmdlet runs a command or script in a disconnected session." }, { "name": "-InputObject", @@ -188,17 +182,16 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies input to the command. Enter a variable that contains the objects or type a command or expression that gets the objects.\n" + "description": "Specifies input to the command. Enter a variable that contains the objects or type a command or expression that gets the objects." }, { "name": "-JobName", "args": [ { - "name": "System.String", - "default": "Job" + "name": "System.String" } ], - "description": "Specifies a friendly name for the background job. By default, jobs are named `Job`, where `` is an ordinal number.\n" + "description": "Specifies a friendly name for the background job. By default, jobs are named `Job`, where `` is an ordinal number." }, { "name": [ @@ -210,11 +203,11 @@ "name": "System.String" } ], - "description": "Specifies a key file path used by Secure Shell (SSH) to authenticate a user on a remote computer.\n" + "description": "Specifies a key file path used by Secure Shell (SSH) to authenticate a user on a remote computer." }, { "name": "-NoNewScope", - "description": "Indicates that this cmdlet runs the specified command in the current scope. By default, `Invoke-Command` runs commands in their own scope.\n" + "description": "Indicates that this cmdlet runs the specified command in the current scope. By default, `Invoke-Command` runs commands in their own scope." }, { "name": "-Options", @@ -223,7 +216,7 @@ "name": "System.Collections.Hashtable" } ], - "description": "Specifies a hashtable of SSH options used when connecting to a remote SSH-based session. The possible options are any values supported by the Unix-based version of the ssh (https://man.openbsd.org/ssh#o)command.\n" + "description": "Specifies a hashtable of SSH options used when connecting to a remote SSH-based session. The possible options are any values supported by the Unix-based version of the [ssh](https://man.openbsd.org/ssh#o) command." }, { "name": "-Port", @@ -232,7 +225,7 @@ "name": "System.Int32" } ], - "description": "Specifies the network port on the remote computer that is used for this command. To connect to a remote computer, the remote computer must be listening on the port that the connection uses. The default ports are 5985 (WinRM port for HTTP) and 5986 (WinRM port for HTTPS).\n" + "description": "Specifies the network port on the remote computer that is used for this command. To connect to a remote computer, the remote computer must be listening on the port that the connection uses. The default ports are 5985 (WinRM port for HTTP) and 5986 (WinRM port for HTTPS)." }, { "name": "-RemoteDebug", @@ -253,7 +246,7 @@ } ], "isRequired": true, - "description": "Specifies the commands to run. Enclose the commands in braces (`{ }`) to create a script block. When using `Invoke-Command` to run a command remotely, any variables in the command are evaluated on the remote computer.\n" + "description": "Specifies the commands to run. Enclose the commands in braces (`{}`) to create a scriptblock. When using `Invoke-Command` to run a command remotely, any variables in the command are evaluated on the remote computer." }, { "name": "-Session", @@ -262,7 +255,7 @@ "name": "System.Management.Automation.Runspaces.PSSession[]" } ], - "description": "Specifies an array of sessions in which this cmdlet runs the command. Enter a variable that contains PSSession objects or a command that creates or gets the PSSession objects, such as a `New-PSSession` or `Get-PSSession` command.\n" + "description": "Specifies an array of sessions in which this cmdlet runs the command. Enter a variable that contains PSSession objects or a command that creates or gets the PSSession objects, such as a `New-PSSession` or `Get-PSSession` command." }, { "name": "-SessionName", @@ -271,7 +264,7 @@ "name": "System.String[]" } ], - "description": "Specifies a friendly name for a disconnected session. You can use the name to refer to the session in subsequent commands, such as a `Get-PSSession` command. This parameter is valid only with the InDisconnectedSession parameter.\n" + "description": "Specifies a friendly name for a disconnected session. You can use the name to refer to the session in subsequent commands, such as a `Get-PSSession` command. This parameter is valid only with the InDisconnectedSession parameter." }, { "name": "-SessionOption", @@ -280,7 +273,7 @@ "name": "System.Management.Automation.Remoting.PSSessionOption" } ], - "description": "Specifies advanced options for the session. Enter a SessionOption object, such as one that you create using the `New-PSSessionOption` cmdlet, or a hash table in which the keys are session option names and the values are session option values.\n" + "description": "Specifies advanced options for the session. Enter a SessionOption object, such as one that you create using the `New-PSSessionOption` cmdlet, or a hash table in which the keys are session option names and the values are session option values." }, { "name": "-SSHConnection", @@ -290,31 +283,29 @@ } ], "isRequired": true, - "description": "This parameter takes an array of hash tables where each hash table contains one or more connection parameters needed to establish a Secure Shell (SSH) connection. The SSHConnection parameter is useful for creating multiple sessions where each session requires different connection information.\n" + "description": "This parameter takes an array of hash tables where each hash table contains one or more connection parameters needed to establish a Secure Shell (SSH) connection. The SSHConnection parameter is useful for creating multiple sessions where each session requires different connection information." }, { "name": "-SSHTransport", - "description": "Indicates that the remote connection is established using Secure Shell (SSH).\n" + "description": "Indicates that the remote connection is established using Secure Shell (SSH)." }, { "name": "-Subsystem", "args": [ { - "name": "System.String", - "default": "powershell" + "name": "System.String" } ], - "description": "Specifies the SSH subsystem used for the new PSSession .\n" + "description": "Specifies the SSH subsystem used for the new PSSession." }, { "name": "-ThrottleLimit", "args": [ { - "name": "System.Int32", - "default": "32" + "name": "System.Int32" } ], - "description": "Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this parameter or enter a value of 0, the default value, 32, is used.\n" + "description": "Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this parameter or enter a value of 0, the default value, 32, is used." }, { "name": "-UserName", @@ -323,11 +314,11 @@ "name": "System.String" } ], - "description": "Specifies the username for the account used to run a command on the remote computer. The user authentication method depends on how Secure Shell (SSH) is configured on the remote computer.\n" + "description": "Specifies the username for the account used to run a command on the remote computer. The user authentication method depends on how Secure Shell (SSH) is configured on the remote computer." }, { "name": "-UseSSL", - "description": "Indicates that this cmdlet uses the Secure Sockets Layer (SSL) protocol to establish a connection to the remote computer. By default, SSL isn't used.\n" + "description": "Indicates that this cmdlet uses the Secure Sockets Layer (SSL) protocol to establish a connection to the remote computer. By default, SSL isn't used." }, { "name": [ @@ -529,7 +520,7 @@ }, { "name": "-FilePath", - "description": "Specifies a local script that this cmdlet runs on one or more remote computers. Enter the path and filename of the script, or pipe a script path to `Invoke-Command`. The script must exist on the local computer or in a directory that the local computer can access. Use ArgumentList to specify the values of parameters in the script.\n" + "description": "Specifies a local script that this cmdlet runs on one or more remote computers. Enter the path and filename of the script, or pipe a script path to `Invoke-Command`. The script must exist on the local computer or in a directory that the local computer can access. Use ArgumentList to specify the values of parameters in the script." } ], "description": "Runs commands on local and remote computers.", diff --git a/command-signatures/json/autogenerated/powershell/invoke-commandindesktoppackage.json b/command-signatures/json/autogenerated/powershell/invoke-commandindesktoppackage.json new file mode 100644 index 00000000..f270609f --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/invoke-commandindesktoppackage.json @@ -0,0 +1,232 @@ +{ + "name": "Invoke-CommandInDesktopPackage", + "options": [ + { + "name": "-AppId", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Args", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Command", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-PackageFamilyName", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-PreventBreakaway" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-PackageFamilyName" + }, + { + "name": "-AppId" + }, + { + "name": "-Command" + }, + { + "name": "-Args" + } + ], + "description": "Invoke-CommandInDesktopPackage [-PackageFamilyName] [[-AppId] ] [-Command] [[-Args] ] [-PreventBreakaway] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/invoke-dscresource.json b/command-signatures/json/autogenerated/powershell/invoke-dscresource.json new file mode 100644 index 00000000..7e161d68 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/invoke-dscresource.json @@ -0,0 +1,247 @@ +{ + "name": "Invoke-DscResource", + "options": [ + { + "name": "-Method", + "args": [ + { + "name": "string", + "suggestions": [ + { + "name": "Get" + }, + { + "name": "Set" + }, + { + "name": "Test" + } + ] + } + ], + "isRequired": true + }, + { + "name": "-ModuleName", + "args": [ + { + "name": "ModuleSpecification" + } + ], + "isRequired": true + }, + { + "name": "-Name", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-Property", + "args": [ + { + "name": "hashtable" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name" + }, + { + "name": "-Method", + "suggestions": [ + { + "name": "Get" + }, + { + "name": "Set" + }, + { + "name": "Test" + } + ] + } + ], + "description": "Invoke-DscResource [-Name] [-Method] -ModuleName -Property []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/invoke-history.json b/command-signatures/json/autogenerated/powershell/invoke-history.json index 3865c6cf..301c987a 100644 --- a/command-signatures/json/autogenerated/powershell/invoke-history.json +++ b/command-signatures/json/autogenerated/powershell/invoke-history.json @@ -1,6 +1,13 @@ { "name": "Invoke-History", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Id", "args": [ @@ -8,14 +15,7 @@ "name": "System.String" } ], - "description": "Specifies the Id of a command in the history. You can type the Id number of the command or the first few characters of the command.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the Id of a command in the history. You can type the Id number of the command or the first few characters of the command." }, { "name": [ @@ -198,7 +198,7 @@ "args": [ { "name": "-Id", - "description": "Specifies the Id of a command in the history. You can type the Id number of the command or the first few characters of the command.\n" + "description": "Specifies the Id of a command in the history. You can type the Id number of the command or the first few characters of the command." } ], "description": "Runs commands from the session history.", diff --git a/command-signatures/json/autogenerated/powershell/invoke-item.json b/command-signatures/json/autogenerated/powershell/invoke-item.json index 8affdb8c..ecba1f6b 100644 --- a/command-signatures/json/autogenerated/powershell/invoke-item.json +++ b/command-signatures/json/autogenerated/powershell/invoke-item.json @@ -1,14 +1,21 @@ { "name": "Invoke-Item", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Exclude", @@ -17,7 +24,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -26,7 +33,7 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Include", @@ -35,7 +42,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -49,7 +56,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Path", @@ -61,13 +68,6 @@ "isRequired": true, "description": "Specifies the path to the selected item. Wildcard characters are permitted." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/invoke-lapspolicyprocessing.json b/command-signatures/json/autogenerated/powershell/invoke-lapspolicyprocessing.json new file mode 100644 index 00000000..744bce8a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/invoke-lapspolicyprocessing.json @@ -0,0 +1,182 @@ +{ + "name": "Invoke-LapsPolicyProcessing", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured policy.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/invoke-restmethod.json b/command-signatures/json/autogenerated/powershell/invoke-restmethod.json index c84c1787..650be4bf 100644 --- a/command-signatures/json/autogenerated/powershell/invoke-restmethod.json +++ b/command-signatures/json/autogenerated/powershell/invoke-restmethod.json @@ -1,9 +1,13 @@ { "name": "Invoke-RestMethod", "options": [ + { + "name": "-AllowInsecureRedirect", + "description": "Allows redirecting from HTTPS to HTTP. By default, any request that's redirected from HTTPS to HTTP results in an error and the request is aborted to prevent unintentionally communicating in plain text over unencrypted connections. To override this behavior at your own risk, use the AllowInsecureRedirect parameter." + }, { "name": "-AllowUnencryptedAuthentication", - "description": "Allows sending of credentials and secrets over unencrypted connections. By default, supplying Credential or any Authentication option with a Uri that does not begin with `https://` will result in an error and the request will abort to prevent unintentionally communicating secrets in plain text over unencrypted connections. To override this behavior at your own risk, supply the AllowUnencryptedAuthentication parameter.\n" + "description": "Allows sending of credentials and secrets over unencrypted connections. By default, supplying Credential or any Authentication option with a Uri that doesn't begin with `https://` results in an error and the request aborts to prevent unintentionally communicating secrets in plain text over unencrypted connections. To override this behavior at your own risk, supply the AllowUnencryptedAuthentication parameter." }, { "name": "-Authentication", @@ -11,22 +15,22 @@ { "name": "Microsoft.PowerShell.Commands.WebAuthenticationType", "suggestions": [ - { - "name": "None" - }, { "name": "Basic" }, { "name": "Bearer" }, + { + "name": "None" + }, { "name": "OAuth" } ] } ], - "description": "Specifies the explicit authentication type to use for the request. The default is None . The Authentication parameter can't be used with the UseDefaultCredentials parameter.\n" + "description": "Specifies the explicit authentication type to use for the request. The default is None. The Authentication parameter can't be used with the UseDefaultCredentials parameter." }, { "name": "-Body", @@ -35,7 +39,7 @@ "name": "System.Object" } ], - "description": "Specifies the body of the request. The body is the content of the request that follows the headers. You can also pipe a body value to `Invoke-RestMethod`.\n" + "description": "Specifies the body of the request. The body is the content of the request that follows the headers. You can also pipe a body value to `Invoke-RestMethod`." }, { "name": "-Certificate", @@ -44,7 +48,7 @@ "name": "System.Security.Cryptography.X509Certificates.X509Certificate" } ], - "description": "Specifies the client certificate that is used for a secure web request. Enter a variable that contains a certificate or a command or expression that gets the certificate.\n" + "description": "Specifies the client certificate that's used for a secure web request. Enter a variable that contains a certificate or a command or expression that gets the certificate." }, { "name": "-CertificateThumbprint", @@ -53,7 +57,19 @@ "name": "System.String" } ], - "description": "Specifies the digital public key certificate (X509) of a user account that has permission to send the request. Enter the certificate thumbprint of the certificate.\n" + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to send the request. Enter the certificate thumbprint of the certificate." + }, + { + "name": [ + "-ConnectionTimeoutSeconds", + "-TimeoutSec" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies how long the request can be pending before it times out. Enter a value in seconds. The default value, 0, specifies an indefinite time-out." }, { "name": "-ContentType", @@ -62,17 +78,16 @@ "name": "System.String" } ], - "description": "Specifies the content type of the web request.\n" + "description": "Specifies the content type of the web request." }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to send the request. The default is the current user.\n" + "description": "Specifies a user account that has permission to send the request. The default is the current user." }, { "name": [ @@ -85,18 +100,18 @@ } ], "isRequired": true, - "description": "Specifies custom method used for the web request. This can be used with the Request Method required by the endpoint is not an available option on the Method . Method and CustomMethod cannot be used together.\n" + "description": "Specifies custom method used for the web request. This can be used with the Request Method required by the endpoint isn't an available option on the Method. Method and CustomMethod can't be used together." }, { "name": "-DisableKeepAlive", - "description": "Indicates that the cmdlet sets the KeepAlive value in the HTTP header to False. By default, KeepAlive is True. KeepAlive establishes a persistent connection to the server to facilitate subsequent requests." + "description": "Sets the KeepAlive value in the HTTP header to False. By default, KeepAlive is True. KeepAlive establishes a persistent connection to the server to facilitate subsequent requests." }, { "name": [ "-FollowRelLink", "-FL" ], - "description": "Indicates the cmdlet should follow relation links.\n" + "description": "Indicates the cmdlet should follow relation links." }, { "name": "-Form", @@ -105,7 +120,7 @@ "name": "System.Collections.IDictionary" } ], - "description": "Converts a dictionary to a `multipart/form-data` submission. Form may not be used with Body . If ContentType will be ignored.\n" + "description": "Converts a dictionary to a `multipart/form-data` submission. Form may not be used with Body. The ContentType is ignored." }, { "name": "-Headers", @@ -114,7 +129,7 @@ "name": "System.Collections.IDictionary" } ], - "description": "Specifies the headers of the web request. Enter a hash table or dictionary.\n" + "description": "Specifies the headers of the web request. Enter a hash table or dictionary." }, { "name": "-HttpVersion", @@ -123,7 +138,7 @@ "name": "System.Version" } ], - "description": "Specifies the HTTP version used for the request. The default is `1.1`.\n" + "description": "Specifies the HTTP version used for the request. The default is `1.1`." }, { "name": "-InFile", @@ -132,7 +147,7 @@ "name": "System.String" } ], - "description": "Gets the content of the web request from a file.\n" + "description": "Gets the content of the web request body from a file. Enter a path and filename. If you omit the path, the default is the current location." }, { "name": [ @@ -141,11 +156,10 @@ ], "args": [ { - "name": "System.Int32", - "default": "Int32.MaxValue" + "name": "System.Int32" } ], - "description": "Specifies how many times to follow relation links if FollowRelLink is used. A smaller value may be needed if the REST api throttles due to too many requests. The default value is `[Int32]::MaxValue`. A value of 0 (zero) prevents following relation links." + "description": "Specifies how many times to follow relation links if FollowRelLink is used. A smaller value may be needed if the REST api throttles due to too many requests. The default value is `[int32]::MaxValue`. A value of 0 (zero) prevents following relation links." }, { "name": "-MaximumRedirection", @@ -163,7 +177,7 @@ "name": "System.Int32" } ], - "description": "Specifies how many times PowerShell retries a connection when a failure code between 400 and 599, inclusive or 304 is received. Also, see the RetryIntervalSec parameter for specifying the number of seconds between retries." + "description": "Specifies how many times PowerShell retries a connection when a failure code between 400 and 599, inclusive or 304 is received. Also see RetryIntervalSec parameter for specifying the interval between retries." }, { "name": "-Method", @@ -175,41 +189,50 @@ "name": "Default" }, { - "name": "Get" + "name": "Delete" }, { - "name": "Head" + "name": "Get" }, { - "name": "Post" + "name": "Head" }, { - "name": "Put" + "name": "Merge" }, { - "name": "Delete" + "name": "Options" }, { - "name": "Trace" + "name": "Patch" }, { - "name": "Options" + "name": "Post" }, { - "name": "Merge" + "name": "Put" }, { - "name": "Patch" + "name": "Trace" } ] } ], - "description": "Specifies the method used for the web request. The acceptable values for this parameter are:\n" + "description": "Specifies the method used for the web request. The acceptable values for this parameter are:" }, { "name": "-NoProxy", "isRequired": true, - "description": "Indicates that the cmdlet will not use a proxy to reach the destination.\n" + "description": "Indicates that the cmdlet won't use a proxy to reach the destination. Use this to bypass the proxy configured in your internet settings or specified in the environment." + }, + { + "name": "-OperationTimeoutSeconds", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "This timeout applies to data reads within a stream, not to the stream time as a whole. The default value, 0, specifies an indefinite timeout." }, { "name": "-OutFile", @@ -218,15 +241,19 @@ "name": "System.String" } ], - "description": "Saves the response body in the specified output file. Enter a path and filename. If you omit the path, the default is the current location. The name is treated as a literal path. Names that contain brackets (`[]`) must be enclosed in single quotes (`'`).\n" + "description": "By default, `Invoke-RestMethod` returns the results to the pipeline. When you use the OutFile parameter, the results are saved to the specified file and not returned to the pipeline. Enter a path and filename. To send the results to a file and to the pipeline, add the PassThru parameter." }, { "name": "-PassThru", - "description": "This parameter is valid only when the OutFile parameter is also used in the command. The intent is to have the results written to the file and to the pipeline.\n" + "description": "This parameter is valid only when the OutFile parameter is also used in the command. The intent is to have the results written to the file and to the pipeline." }, { "name": "-PreserveAuthorizationOnRedirect", - "description": "Indicates the cmdlet should preserve the `Authorization` header, when present, across redirections.\n" + "description": "Indicates the cmdlet should preserve the `Authorization` header, when present, across redirections." + }, + { + "name": "-PreserveHttpMethodOnRedirect", + "description": "Indicates the cmdlet should preserve the method of the request across redirections." }, { "name": "-Proxy", @@ -235,7 +262,7 @@ "name": "System.Uri" } ], - "description": "Uses a proxy server for the request, rather than connecting directly to the internet resource. Enter the Uniform Resource Identifier (URI) of a network proxy server.\n" + "description": "Uses a proxy server for the request, rather than connecting directly to the internet resource. Enter the Uniform Resource Identifier (URI) of a network proxy server." }, { "name": "-ProxyCredential", @@ -244,11 +271,11 @@ "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to use the proxy server that is specified by the Proxy parameter. The default is the current user.\n" + "description": "Specifies a user account that has permission to use the proxy server that's specified by the Proxy parameter. The default is the current user." }, { "name": "-ProxyUseDefaultCredentials", - "description": "Indicates that the cmdlet uses the credentials of the current user to access the proxy server that is specified by the Proxy parameter.\n" + "description": "Uses the credentials of the current user to access the proxy server that is specified by the Proxy parameter." }, { "name": [ @@ -260,21 +287,20 @@ "name": "System.String" } ], - "description": "Creates a variable containing a Response Headers Dictionary. Enter a variable name without the dollar sign (`$`) symbol. The keys of the dictionary contain the field names and values of the Response Header returned by the web server.\n" + "description": "Creates a variable containing a Response Headers Dictionary. Enter a variable name without the dollar sign (`$`) symbol. The keys of the dictionary contain the field names and values of the Response Header returned by the web server." }, { "name": "-Resume", - "description": "Performs a best effort attempt to resume downloading a partial file. The Resume parameter requires the OutFile parameter. Resume only operates on the size of the local file and remote file and performs no other validation that the local file and the remote file are the same.\n" + "description": "Performs a best effort attempt to resume downloading a partial file. The Resume parameter requires the OutFile parameter." }, { "name": "-RetryIntervalSec", "args": [ { - "name": "System.Int32", - "default": "5" + "name": "System.Int32" } ], - "description": "Specifies the interval between retries for the connection when a failure code between 400 and 599, inclusive or 304 is received. The value must be between `1` and `[int]::MaxValue`.\n" + "description": "Specifies the interval between retries for the connection when a failure code between 400 and 599, inclusive or 304 is received. The value must be between `1` and `[int]::MaxValue`. When the failure code is 429 and the response includes the Retry-After property in its headers, the cmdlet uses that value for the retry interval, even if this parameter is specified." }, { "name": [ @@ -286,19 +312,19 @@ "name": "System.String" } ], - "description": "Creates a variable containing the web request session. Enter a variable name without the dollar sign (`$`) symbol.\n" + "description": "Creates a variable containing the web request session. Enter a variable name without the dollar sign (`$`) symbol." }, { "name": "-SkipCertificateCheck", - "description": "Skips certificate validation checks that include all validations such as expiration, revocation, trusted root authority, etc.\n" + "description": "Skips certificate validation checks that include all validations such as expiration, revocation, trusted root authority, etc." }, { "name": "-SkipHeaderValidation", - "description": "Indicates the cmdlet should add headers to the request without validation.\n" + "description": "Indicates the cmdlet should add headers to the request without validation." }, { "name": "-SkipHttpErrorCheck", - "description": "This parameter causes the cmdlet to ignore HTTP error statuses and continue to process responses. The error responses are written to the pipeline just as if they were successful.\n" + "description": "This parameter causes the cmdlet to ignore HTTP error statuses and continue to process responses. The error responses are written to the pipeline just as if they were successful." }, { "name": "-SslProtocol", @@ -324,7 +350,7 @@ ] } ], - "description": "Sets the SSL/TLS protocols that are permissible for the web request. By default all, SSL/TLS protocols supported by the system are allowed. SslProtocol allows for limiting to specific protocols for compliance purposes.\n" + "description": "Sets the SSL/TLS protocols that are permissible for the web request. By default all, SSL/TLS protocols supported by the system are allowed. SslProtocol allows for limiting to specific protocols for compliance purposes." }, { "name": "-StatusCodeVariable", @@ -333,16 +359,7 @@ "name": "System.String" } ], - "description": "Creates a variable containing a HTTP status code result of the request. Enter a variable name without the dollar sign (`$`) symbol.\n" - }, - { - "name": "-TimeoutSec", - "args": [ - { - "name": "System.Int32" - } - ], - "description": "Specifies how long the request can be pending before it times out. Enter a value in seconds. The default value, 0, specifies an indefinite time-out.\n" + "description": "Creates a variable containing a HTTP status code result of the request. Enter a variable name without the dollar sign (`$`) symbol." }, { "name": "-Token", @@ -351,7 +368,7 @@ "name": "System.Security.SecureString" } ], - "description": "The OAuth or Bearer token to include in the request. Token is required by certain Authentication options. It can't be used independently. Token takes a `SecureString` that contains the token. To supply the token, manually use the following:\n" + "description": "The OAuth or Bearer token to include in the request. Token is required by certain Authentication options. It can't be used independently." }, { "name": "-TransferEncoding", @@ -377,7 +394,16 @@ ] } ], - "description": "Specifies a value for the transfer-encoding HTTP response header. The acceptable values for this parameter are:\n" + "description": "Specifies a value for the transfer-encoding HTTP response header. The acceptable values for this parameter are:" + }, + { + "name": "-UnixSocket", + "args": [ + { + "name": "System.Net.Sockets.UnixDomainSocketEndPoint" + } + ], + "description": "Specifies the name of the Unix socket to connect to. This parameter is supported on Unix-based systems and Windows version 1803 and later. For more information about Windows support of Unix sockets, see the [Windows/WSL Interop with AF_UNIX](https://devblogs.microsoft.com/commandline/windowswsl-interop-with-af_unix/) blog post." }, { "name": "-Uri", @@ -387,11 +413,11 @@ } ], "isRequired": true, - "description": "Specifies the Uniform Resource Identifier (URI) of the internet resource to which the web request is sent. This parameter supports HTTP, HTTPS, FTP, and FILE values.\n" + "description": "Specifies the Uniform Resource Identifier (URI) of the internet resource to which the web request is sent. This parameter supports HTTP, HTTPS, FTP, and FILE values." }, { "name": "-UseBasicParsing", - "description": "This parameter has been deprecated. Beginning with PowerShell 6.0.0, all Web requests use basic parsing only. This parameter is included for backwards compatibility only and any use of it will have no effect on the operation of the cmdlet." + "description": "This parameter has been deprecated. Beginning with PowerShell 6.0.0, all Web requests use basic parsing only. This parameter is included for backwards compatibility only. When used, it has no effect on the operation of the cmdlet." }, { "name": "-UseDefaultCredentials", @@ -404,7 +430,7 @@ "name": "System.String" } ], - "description": "Specifies a user agent string for the web request.\n" + "description": "Specifies a user agent string for the web request." }, { "name": "-WebSession", @@ -413,7 +439,7 @@ "name": "Microsoft.PowerShell.Commands.WebRequestSession" } ], - "description": "Specifies a web request session. Enter the variable name, including the dollar sign (`$`).\n" + "description": "Specifies a web request session. Enter the variable name, including the dollar sign (`$`)." }, { "name": [ @@ -589,7 +615,7 @@ "args": [ { "name": "-Uri", - "description": "Specifies the Uniform Resource Identifier (URI) of the internet resource to which the web request is sent. This parameter supports HTTP, HTTPS, FTP, and FILE values.\n" + "description": "Specifies the Uniform Resource Identifier (URI) of the internet resource to which the web request is sent. This parameter supports HTTP, HTTPS, FTP, and FILE values." } ], "description": "Sends an HTTP or HTTPS request to a RESTful web service.", diff --git a/command-signatures/json/autogenerated/powershell/invoke-troubleshootingpack.json b/command-signatures/json/autogenerated/powershell/invoke-troubleshootingpack.json new file mode 100644 index 00000000..aa35d786 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/invoke-troubleshootingpack.json @@ -0,0 +1,231 @@ +{ + "name": "Invoke-TroubleshootingPack", + "options": [ + { + "name": [ + "-AnswerFile", + "-AF" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a path for an answer file. You can use an absolute path, a relative path, or a Universal Naming Convention (UNC) path. To generate an answer file, use the Get-TroubleshootingPack cmdlet." + }, + { + "name": [ + "-Pack", + "-P" + ], + "args": [ + { + "name": "DiagPack" + } + ], + "isRequired": true, + "description": "Specifies a DiagPack object. The DiagPack object defines a troubleshooting pack. To obtain a DiagPack object, use the Get-TroubleshootingPack cmdlet." + }, + { + "name": [ + "-Result", + "-R" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a path for the result report and the debug report. You can use an absolute path, a relative path, or a Universal Naming Convention (UNC) path." + }, + { + "name": [ + "-Unattended", + "-U" + ], + "description": "Indicates that the troubleshooting pack runs in unattended mode. If you specify this parameter and the troubleshooting pack requires input, specify an answer file in the AnswerFile parameter." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Pack", + "description": "Specifies a DiagPack object. The DiagPack object defines a troubleshooting pack. To obtain a DiagPack object, use the Get-TroubleshootingPack cmdlet." + } + ], + "description": "Runs a troubleshooting pack.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/invoke-webrequest.json b/command-signatures/json/autogenerated/powershell/invoke-webrequest.json index af41bdba..30df9d4b 100644 --- a/command-signatures/json/autogenerated/powershell/invoke-webrequest.json +++ b/command-signatures/json/autogenerated/powershell/invoke-webrequest.json @@ -1,9 +1,13 @@ { "name": "Invoke-WebRequest", "options": [ + { + "name": "-AllowInsecureRedirect", + "description": "Allows redirecting from HTTPS to HTTP. By default, any request that's redirected from HTTPS to HTTP results in an error and the request is aborted to prevent unintentionally communicating in plain text over unencrypted connections. To override this behavior at your own risk, use the AllowInsecureRedirect parameter." + }, { "name": "-AllowUnencryptedAuthentication", - "description": "Allows sending of credentials and secrets over unencrypted connections. By default, supplying Credential or any Authentication option with a Uri that doesn't begin with `https://` results in an error and the request is aborted to prevent unintentionally communicating secrets in plain text over unencrypted connections. To override this behavior at your own risk, supply the AllowUnencryptedAuthentication parameter.\n" + "description": "Allows sending of credentials and secrets over unencrypted connections. By default, supplying Credential or any Authentication option with a Uri that doesn't begin with `https://` results in an error and the request is aborted to prevent unintentionally communicating secrets in plain text over unencrypted connections. To override this behavior at your own risk, supply the AllowUnencryptedAuthentication parameter." }, { "name": "-Authentication", @@ -11,22 +15,22 @@ { "name": "Microsoft.PowerShell.Commands.WebAuthenticationType", "suggestions": [ - { - "name": "None" - }, { "name": "Basic" }, { "name": "Bearer" }, + { + "name": "None" + }, { "name": "OAuth" } ] } ], - "description": "Specifies the explicit authentication type to use for the request. The default is None . The Authentication parameter can't be used with the UseDefaultCredentials parameter.\n" + "description": "Specifies the explicit authentication type to use for the request. The default is None. The Authentication parameter can't be used with the UseDefaultCredentials parameter." }, { "name": "-Body", @@ -35,7 +39,7 @@ "name": "System.Object" } ], - "description": "Specifies the body of the request. The body is the content of the request that follows the headers. You can also pipe a body value to `Invoke-WebRequest`.\n" + "description": "Specifies the body of the request. The body is the content of the request that follows the headers. You can also pipe a body value to `Invoke-WebRequest`." }, { "name": "-Certificate", @@ -44,7 +48,7 @@ "name": "System.Security.Cryptography.X509Certificates.X509Certificate" } ], - "description": "Specifies the client certificate that's used for a secure web request. Enter a variable that contains a certificate or a command or expression that gets the certificate.\n" + "description": "Specifies the client certificate that's used for a secure web request. Enter a variable that contains a certificate or a command or expression that gets the certificate." }, { "name": "-CertificateThumbprint", @@ -53,7 +57,19 @@ "name": "System.String" } ], - "description": "Specifies the digital public key certificate (X509) of a user account that has permission to send the request. Enter the certificate thumbprint of the certificate.\n" + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to send the request. Enter the certificate thumbprint of the certificate." + }, + { + "name": [ + "-ConnectionTimeoutSeconds", + "-TimeoutSec" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies how long the request can be pending before it times out. Enter a value in seconds. The default value, 0, specifies an indefinite time-out." }, { "name": "-ContentType", @@ -62,17 +78,16 @@ "name": "System.String" } ], - "description": "Specifies the content type of the web request.\n" + "description": "Specifies the content type of the web request." }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to send the request. The default is the current user.\n" + "description": "Specifies a user account that has permission to send the request. The default is the current user." }, { "name": [ @@ -85,11 +100,11 @@ } ], "isRequired": true, - "description": "Specifies a custom method used for the web request. This can be used if the Request Method required by the endpoint isn't an available option on the Method . Method and CustomMethod can't be used together.\n" + "description": "Specifies a custom method used for the web request. This can be used if the Request Method required by the endpoint isn't an available option on the Method. Method and CustomMethod can't be used together." }, { "name": "-DisableKeepAlive", - "description": "Indicates that the cmdlet sets the KeepAlive value in the HTTP header to False . By default, KeepAlive is True . KeepAlive establishes a persistent connection to the server to facilitate subsequent requests." + "description": "Indicates that the cmdlet sets the KeepAlive value in the HTTP header to False. By default, KeepAlive is True. KeepAlive establishes a persistent connection to the server to facilitate subsequent requests." }, { "name": "-Form", @@ -98,7 +113,7 @@ "name": "System.Collections.IDictionary" } ], - "description": "Converts a dictionary to a `multipart/form-data` submission. Form may not be used with Body . If ContentType is used, it's ignored.\n" + "description": "Converts a dictionary to a `multipart/form-data` submission. Form may not be used with Body. If ContentType is used, it's ignored." }, { "name": "-Headers", @@ -107,17 +122,16 @@ "name": "System.Collections.IDictionary" } ], - "description": "Specifies the headers of the web request. Enter a hash table or dictionary.\n" + "description": "Specifies the headers of the web request. Enter a hash table or dictionary." }, { "name": "-HttpVersion", "args": [ { - "name": "System.Version", - "default": "1.1" + "name": "System.Version" } ], - "description": "Specifies the HTTP version used for the request. The default is `1.1`.\n" + "description": "Specifies the HTTP version used for the request. The default is `1.1`." }, { "name": "-InFile", @@ -126,14 +140,13 @@ "name": "System.String" } ], - "description": "Gets the content of the web request from a file. Enter a path and filename. If you omit the path, the default is the current location." + "description": "Gets the content of the web request body from a file. Enter a path and filename. If you omit the path, the default is the current location." }, { "name": "-MaximumRedirection", "args": [ { - "name": "System.Int32", - "default": "5" + "name": "System.Int32" } ], "description": "Specifies how many times PowerShell redirects a connection to an alternate Uniform Resource Identifier (URI) before the connection fails. The default value is 5. A value of 0 (zero) prevents all redirection." @@ -145,7 +158,7 @@ "name": "System.Int32" } ], - "description": "Specifies how many times PowerShell retries a connection when a failure code between 400 and 599, inclusive or 304 is received. Also see RetryIntervalSec parameter for specifying number of retries." + "description": "Specifies how many times PowerShell retries a connection when a failure code between 400 and 599, inclusive or 304 is received. Also see RetryIntervalSec parameter for specifying the interval between retries." }, { "name": "-Method", @@ -157,42 +170,51 @@ "name": "Default" }, { - "name": "Get" + "name": "Delete" }, { - "name": "Head" + "name": "Get" }, { - "name": "Post" + "name": "Head" }, { - "name": "Put" + "name": "Merge" }, { - "name": "Delete" + "name": "Options" }, { - "name": "Trace" + "name": "Patch" }, { - "name": "Options" + "name": "Post" }, { - "name": "Merge" + "name": "Put" }, { - "name": "Patch" + "name": "Trace" } ] } ], - "description": "Specifies the method used for the web request. The acceptable values for this parameter are:\n" + "description": "Specifies the method used for the web request. The acceptable values for this parameter are:" }, { "name": "-NoProxy", "isRequired": true, "description": "Indicates that the cmdlet shouldn't use a proxy to reach the destination. When you need to bypass the proxy configured in the environment, use this switch. This feature was added in PowerShell 6.0.0." }, + { + "name": "-OperationTimeoutSeconds", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "This timeout applies to data reads within a stream, not to the stream time as a whole. The default value, 0, specifies an indefinite timeout." + }, { "name": "-OutFile", "args": [ @@ -200,7 +222,7 @@ "name": "System.String" } ], - "description": "Specifies the output file for which this cmdlet saves the response body. Enter a path and filename. If you omit the path, the default is the current location. The name is treated as a literal path. Names that contain brackets (`[]`) must be enclosed in single quotes (`'`).\n" + "description": "By default, `Invoke-WebRequest` returns the results to the pipeline. When you use the OutFile parameter, the results are saved to the specified file and not returned to the pipeline. Enter a path and filename. To send the results to a file and to the pipeline, add the PassThru parameter." }, { "name": "-PassThru", @@ -208,7 +230,11 @@ }, { "name": "-PreserveAuthorizationOnRedirect", - "description": "Indicates the cmdlet should preserve the `Authorization` header, when present, across redirections.\n" + "description": "Indicates the cmdlet should preserve the `Authorization` header, when present, across redirections." + }, + { + "name": "-PreserveHttpMethodOnRedirect", + "description": "Indicates the cmdlet should preserve the method of the request across redirections." }, { "name": "-Proxy", @@ -223,26 +249,24 @@ "name": "-ProxyCredential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to use the proxy server specified by the Proxy parameter. The default is the current user.\n" + "description": "Specifies a user account that has permission to use the proxy server specified by the Proxy parameter. The default is the current user." }, { "name": "-ProxyUseDefaultCredentials", - "description": "Indicates that the cmdlet uses the credentials of the current user to access the proxy server that is specified by the Proxy parameter.\n" + "description": "Indicates that the cmdlet uses the credentials of the current user to access the proxy server that is specified by the Proxy parameter." }, { "name": "-Resume", - "description": "Performs a best effort attempt to resume downloading a partial file. Resume requires OutFile . Resume only operates on the size of the local file and remote file and performs no other validation that the local file and the remote file are the same.\n" + "description": "Performs a best effort attempt to resume downloading a partial file. Resume requires OutFile." }, { "name": "-RetryIntervalSec", "args": [ { - "name": "System.Int32", - "default": "5" + "name": "System.Int32" } ], "description": "Specifies the interval between retries for the connection when a failure code between 400 and 599, inclusive or 304 is received. Also see MaximumRetryCount parameter for specifying number of retries. The value must be between `1` and `[int]::MaxValue`." @@ -257,19 +281,19 @@ "name": "System.String" } ], - "description": "Specifies a variable for which this cmdlet creates a web request session and saves it in the value. Enter a variable name without the dollar sign (`$`) symbol.\n" + "description": "Specifies a variable for which this cmdlet creates a web request session and saves it in the value. Enter a variable name without the dollar sign (`$`) symbol." }, { "name": "-SkipCertificateCheck", - "description": "Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.\n" + "description": "Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc." }, { "name": "-SkipHeaderValidation", - "description": "Indicates the cmdlet should add headers to the request without validation.\n" + "description": "Indicates the cmdlet should add headers to the request without validation." }, { "name": "-SkipHttpErrorCheck", - "description": "This parameter causes the cmdlet to ignore HTTP error statuses and continue to process responses. The error responses are written to the pipeline just as if they were successful.\n" + "description": "This parameter causes the cmdlet to ignore HTTP error statuses and continue to process responses. The error responses are written to the pipeline just as if they were successful." }, { "name": "-SslProtocol", @@ -288,21 +312,14 @@ }, { "name": "Tls12" + }, + { + "name": "Tls13" } ] } ], - "description": "Sets the SSL/TLS protocols that are permissible for the web request. By default all, SSL/TLS protocols supported by the system are allowed. SslProtocol allows for limiting to specific protocols for compliance purposes.\n" - }, - { - "name": "-TimeoutSec", - "args": [ - { - "name": "System.Int32", - "default": "0" - } - ], - "description": "Specifies how long the request can be pending before it times out. Enter a value in seconds. The default value, 0, specifies an indefinite time-out.\n" + "description": "Sets the SSL/TLS protocols that are permissible for the web request. By default all, SSL/TLS protocols supported by the system are allowed. SslProtocol allows for limiting to specific protocols for compliance purposes." }, { "name": "-Token", @@ -311,7 +328,7 @@ "name": "System.Security.SecureString" } ], - "description": "The OAuth or Bearer token to include in the request. Token is required by certain Authentication options. It can't be used independently. Token takes a `SecureString` containing the token. To supply the token manually use the following:\n" + "description": "The OAuth or Bearer token to include in the request. Token is required by certain Authentication options. It can't be used independently." }, { "name": "-TransferEncoding", @@ -337,7 +354,16 @@ ] } ], - "description": "Specifies a value for the transfer-encoding HTTP response header. The acceptable values for this parameter are:\n" + "description": "Specifies a value for the transfer-encoding HTTP response header. The acceptable values for this parameter are:" + }, + { + "name": "-UnixSocket", + "args": [ + { + "name": "System.Net.Sockets.UnixDomainSocketEndPoint" + } + ], + "description": "Specifies the name of the Unix socket to connect to. This parameter is supported on Unix-based systems and Windows version 1803 and later. For more information about Windows support of Unix sockets, see the [Windows/WSL Interop with AF_UNIX](https://devblogs.microsoft.com/commandline/windowswsl-interop-with-af_unix/) blog post." }, { "name": "-Uri", @@ -347,7 +373,7 @@ } ], "isRequired": true, - "description": "Specifies the Uniform Resource Identifier (URI) of the internet resource to which the web request is sent. Enter a URI. This parameter supports HTTP or HTTPS only.\n" + "description": "Specifies the Uniform Resource Identifier (URI) of the internet resource to which the web request is sent. Enter a URI. This parameter supports HTTP or HTTPS only." }, { "name": "-UseBasicParsing", @@ -364,7 +390,7 @@ "name": "System.String" } ], - "description": "Specifies a user agent string for the web request.\n" + "description": "Specifies a user agent string for the web request." }, { "name": "-WebSession", @@ -373,7 +399,7 @@ "name": "Microsoft.PowerShell.Commands.WebRequestSession" } ], - "description": "Specifies a web request session. Enter the variable name, including the dollar sign (`$`).\n" + "description": "Specifies a web request session. Enter the variable name, including the dollar sign (`$`)." }, { "name": [ @@ -549,7 +575,7 @@ "args": [ { "name": "-Uri", - "description": "Specifies the Uniform Resource Identifier (URI) of the internet resource to which the web request is sent. Enter a URI. This parameter supports HTTP or HTTPS only.\n" + "description": "Specifies the Uniform Resource Identifier (URI) of the internet resource to which the web request is sent. Enter a URI. This parameter supports HTTP or HTTPS only." } ], "description": "Gets content from a web page on the internet.", diff --git a/command-signatures/json/autogenerated/powershell/invoke-wmimethod.json b/command-signatures/json/autogenerated/powershell/invoke-wmimethod.json new file mode 100644 index 00000000..5442a48d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/invoke-wmimethod.json @@ -0,0 +1,370 @@ +{ + "name": "Invoke-WmiMethod", + "options": [ + { + "name": [ + "-ArgumentList", + "-Args" + ], + "args": [ + { + "name": "Object[]" + } + ] + }, + { + "name": "-AsJob" + }, + { + "name": "-Authentication", + "args": [ + { + "name": "AuthenticationLevel", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "None" + }, + { + "name": "Connect" + }, + { + "name": "Call" + }, + { + "name": "Packet" + }, + { + "name": "PacketIntegrity" + }, + { + "name": "PacketPrivacy" + }, + { + "name": "Unchanged" + } + ] + } + ] + }, + { + "name": "-Authority", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Class", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-ComputerName", + "-Cn" + ], + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Credential", + "args": [ + { + "name": "pscredential" + } + ] + }, + { + "name": "-EnableAllPrivileges" + }, + { + "name": "-Impersonation", + "args": [ + { + "name": "ImpersonationLevel", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "Anonymous" + }, + { + "name": "Identify" + }, + { + "name": "Impersonate" + }, + { + "name": "Delegate" + } + ] + } + ] + }, + { + "name": "-InputObject", + "args": [ + { + "name": "wmi" + } + ], + "isRequired": true + }, + { + "name": "-Locale", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Name", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Namespace", + "-NS" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Path", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-ThrottleLimit", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Class" + }, + { + "name": "-Name" + }, + { + "name": "-ArgumentList" + } + ], + "description": "Invoke-WmiMethod [-Class] [-Name] [[-ArgumentList] ] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] [] Invoke-WmiMethod [-Name] -InputObject [-ArgumentList ] [-AsJob] [-ThrottleLimit ] [-WhatIf] [-Confirm] [] Invoke-WmiMethod [-Name] -Path [-ArgumentList ] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] [] Invoke-WmiMethod [-Name] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] [] Invoke-WmiMethod [-Name] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] [] Invoke-WmiMethod [-Name] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/invoke-wsmanaction.json b/command-signatures/json/autogenerated/powershell/invoke-wsmanaction.json new file mode 100644 index 00000000..37f6f0f9 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/invoke-wsmanaction.json @@ -0,0 +1,380 @@ +{ + "name": "Invoke-WSManAction", + "options": [ + { + "name": "-Action", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the method to run on the management object specified by the ResourceURI and selectors." + }, + { + "name": "-ApplicationName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the application name in the connection. The default value of the ApplicationName parameter is WSMAN. The complete identifier for the remote endpoint is in the following format:" + }, + { + "name": [ + "-Authentication", + "-auth", + "-am" + ], + "args": [ + { + "name": "Microsoft.WSMan.Management.AuthenticationMechanism", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "ClientCertificate" + }, + { + "name": "Credssp" + }, + { + "name": "Default" + }, + { + "name": "Digest" + }, + { + "name": "Kerberos" + }, + { + "name": "Negotiate" + }, + { + "name": "None" + } + ] + } + ], + "description": "Specifies the authentication mechanism to be used at the server. Possible values are:" + }, + { + "name": "-CertificateThumbprint", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to perform this action. Enter the certificate thumbprint of the certificate." + }, + { + "name": [ + "-ComputerName", + "-cn" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the computer against which you want to run the management operation. The value can be a fully qualified domain name, a NetBIOS name, or an IP address. Use the local computer name, use localhost, or use a dot (`.`) to specify the local computer. The local computer is the default. When the remote computer is in a different domain from the user, you must use a fully qualified domain name must be used. You can pipe a value for this parameter to the cmdlet." + }, + { + "name": [ + "-ConnectionURI", + "-CURI", + "-CU" + ], + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the connection endpoint. The format of this string is:" + }, + { + "name": [ + "-Credential", + "-cred", + "-c" + ], + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to perform this action. The default is the current user. Type a user name, such as \"User01\", \"Domain01\\User01\", or User@Domain.com. Or, enter a PSCredential object, such as one returned by the `Get-Credential` cmdlet. When you type a user name, you will be prompted for a password." + }, + { + "name": [ + "-FilePath", + "-Path" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the path of a file that is used to update a management resource. You specify the management resource by using the ResourceURI parameter and the SelectorSet parameter. For example, the following command uses the FilePath parameter:" + }, + { + "name": [ + "-OptionSet", + "-os" + ], + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "description": "Passes a set of switches to a service to modify or refine the nature of the request. These are similar to switches used in command-line shells because they are service specific. Any number of options can be specified." + }, + { + "name": "-Port", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies the port to use when the client connects to the WinRM service. When the transport is HTTP, the default port is 80. When the transport is HTTPS, the default port is 443. When you use HTTPS as the transport, the value of the ComputerName parameter must match the server's certificate common name (CN). However, if the SkipCNCheck parameter is specified as part of the SessionOption parameter, then the certificate common name of the server does not have to match the host name of the server. The SkipCNCheck parameter should be used only for trusted machines." + }, + { + "name": [ + "-ResourceURI", + "-ruri" + ], + "args": [ + { + "name": "System.Uri" + } + ], + "isRequired": true, + "description": "Contains the Uniform Resource Identifier (URI) of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": "-SelectorSet", + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "description": "Specifies a set of value pairs that are used to select particular management resource instances. SelectorSet is used when more than one instance of the resource exists. The value of SelectorSet must be a hash table." + }, + { + "name": [ + "-SessionOption", + "-so" + ], + "args": [ + { + "name": "Microsoft.WSMan.Management.SessionOption" + } + ], + "description": "Defines a set of extended options for the WS-Management session. Enter a SessionOption object that you create by using the `New-WSManSessionOption` cmdlet. For more information about the options that are available, see `New-WSManSessionOption`." + }, + { + "name": "-UseSSL", + "description": "Specifies that the Secure Sockets Layer (SSL) protocol is used to establish a connection to the remote computer. By default, SSL is not used." + }, + { + "name": "-ValueSet", + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "description": "Specifies a hash table that helps modify a management resource. You specify the management resource using the ResourceURI and SelectorSet parameters. The value of the ValueSet parameter must be a hash table." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ResourceURI", + "description": "Contains the Uniform Resource Identifier (URI) of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": "-Action", + "description": "Specifies the method to run on the management object specified by the ResourceURI and selectors." + }, + { + "name": "-SelectorSet", + "description": "Specifies a set of value pairs that are used to select particular management resource instances. SelectorSet is used when more than one instance of the resource exists. The value of SelectorSet must be a hash table." + } + ], + "description": "Invokes an action on the object that is specified by the Resource URI and by the selectors.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/join-dtcdiagnosticresourcemanager.json b/command-signatures/json/autogenerated/powershell/join-dtcdiagnosticresourcemanager.json new file mode 100644 index 00000000..041b250e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/join-dtcdiagnosticresourcemanager.json @@ -0,0 +1,220 @@ +{ + "name": "Join-DtcDiagnosticResourceManager", + "options": [ + { + "name": "-ComputerName", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Port", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-Transaction", + "args": [ + { + "name": "DtcDiagnosticTransaction" + } + ], + "isRequired": true + }, + { + "name": "-Volatile" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Transaction" + }, + { + "name": "-ComputerName" + }, + { + "name": "-Port" + } + ], + "description": "Join-DtcDiagnosticResourceManager [-Transaction] [[-ComputerName] ] [[-Port] ] [-Volatile] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/join-path.json b/command-signatures/json/autogenerated/powershell/join-path.json index 67b16258..4181058c 100644 --- a/command-signatures/json/autogenerated/powershell/join-path.json +++ b/command-signatures/json/autogenerated/powershell/join-path.json @@ -8,7 +8,7 @@ "name": "System.String[]" } ], - "description": "Specifies additional elements to append to the value of the Path parameter. The `ChildPath` parameter is still mandatory and must be specified as well.\n" + "description": "Specifies additional elements to append to the value of the Path parameter. The ChildPath parameter is still mandatory and must be specified as well. This parameter is specified with the `ValueFromRemainingArguments` property, which enables joining an indefinite number of paths." }, { "name": "-ChildPath", @@ -18,7 +18,7 @@ } ], "isRequired": true, - "description": "Specifies the elements to append to the value of the `Path` parameter. Wildcards are permitted. The `ChildPath` parameter is required, although the parameter name (\"ChildPath\") is optional." + "description": "Specifies the elements to append to the value of the `Path` parameter. Wildcards are permitted." }, { "name": "-Credential", @@ -26,7 +26,8 @@ { "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter isn't supported by any providers installed with PowerShell. To impersonate another > user, or elevate your credentials when running this cmdlet, use > [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": [ @@ -39,11 +40,11 @@ } ], "isRequired": true, - "description": "Specifies the main path (or paths) to which the child-path is appended. Wildcards are permitted.\n" + "description": "Specifies the main path (or paths) to which the child-path is appended. The value of Path determines which provider joins the paths and adds the path delimiters. Wildcards are permitted." }, { "name": "-Resolve", - "description": "Indicates that this cmdlet should attempt to resolve the joined path from the current provider.\n" + "description": "Indicates that this cmdlet should attempt to resolve the joined path from the current provider." }, { "name": [ @@ -219,15 +220,15 @@ "args": [ { "name": "-Path", - "description": "Specifies the main path (or paths) to which the child-path is appended. Wildcards are permitted.\n" + "description": "Specifies the main path (or paths) to which the child-path is appended. The value of Path determines which provider joins the paths and adds the path delimiters. Wildcards are permitted." }, { "name": "-ChildPath", - "description": "Specifies the elements to append to the value of the `Path` parameter. Wildcards are permitted. The `ChildPath` parameter is required, although the parameter name (\"ChildPath\") is optional." + "description": "Specifies the elements to append to the value of the `Path` parameter. Wildcards are permitted." }, { "name": "-AdditionalChildPath", - "description": "Specifies additional elements to append to the value of the Path parameter. The `ChildPath` parameter is still mandatory and must be specified as well.\n" + "description": "Specifies additional elements to append to the value of the Path parameter. The ChildPath parameter is still mandatory and must be specified as well. This parameter is specified with the `ValueFromRemainingArguments` property, which enables joining an indefinite number of paths." } ], "description": "Combines a path and a child path into a single path.", diff --git a/command-signatures/json/autogenerated/powershell/join-string.json b/command-signatures/json/autogenerated/powershell/join-string.json index 69bec32c..ca074769 100644 --- a/command-signatures/json/autogenerated/powershell/join-string.json +++ b/command-signatures/json/autogenerated/powershell/join-string.json @@ -12,7 +12,7 @@ "name": "System.String" } ], - "description": "Specifies a format string that specifies how each pipeline object should be formatted before joining them. Use the `{0}` placeholder to represent the current object. If you need to keep the curly braces (`{}`) in the formatted string, you can escape them by doubling the curly braces (`{{` and `}}`).\n" + "description": "Specifies a format string that specifies how each pipeline object should be formatted before joining them. Use the `{0}` placeholder to represent the current object. If you need to keep the curly braces (`{}`) in the formatted string, you can escape them by doubling the curly braces (`{{` and `}}`)." }, { "name": "-InputObject", @@ -63,7 +63,7 @@ "name": "System.String" } ], - "description": "Text or characters such as a comma or semicolon that's inserted between the text for each pipeline object.\n" + "description": "Text or characters such as a comma or semicolon that's inserted between the text for each pipeline object." }, { "name": "-SingleQuote", @@ -251,7 +251,7 @@ }, { "name": "-Separator", - "description": "Text or characters such as a comma or semicolon that's inserted between the text for each pipeline object.\n" + "description": "Text or characters such as a comma or semicolon that's inserted between the text for each pipeline object." } ], "description": "Combines objects from the pipeline into a single string.", diff --git a/command-signatures/json/autogenerated/powershell/limit-eventlog.json b/command-signatures/json/autogenerated/powershell/limit-eventlog.json new file mode 100644 index 00000000..55f44beb --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/limit-eventlog.json @@ -0,0 +1,262 @@ +{ + "name": "Limit-EventLog", + "options": [ + { + "name": [ + "-ComputerName", + "-CN" + ], + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": [ + "-LogName", + "-LN" + ], + "args": [ + { + "name": "string[]" + } + ], + "isRequired": true + }, + { + "name": "-MaximumSize", + "args": [ + { + "name": "long" + } + ] + }, + { + "name": [ + "-OverflowAction", + "-OFA" + ], + "args": [ + { + "name": "OverflowAction", + "suggestions": [ + { + "name": "OverwriteOlder" + }, + { + "name": "OverwriteAsNeeded" + }, + { + "name": "DoNotOverwrite" + } + ] + } + ] + }, + { + "name": [ + "-RetentionDays", + "-MRD" + ], + "args": [ + { + "name": "int" + } + ] + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-LogName" + } + ], + "description": "Limit-EventLog [-LogName] [-ComputerName ] [-RetentionDays ] [-OverflowAction ] [-MaximumSize ] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/measure-command.json b/command-signatures/json/autogenerated/powershell/measure-command.json index f374ef0f..1f0d6e4c 100644 --- a/command-signatures/json/autogenerated/powershell/measure-command.json +++ b/command-signatures/json/autogenerated/powershell/measure-command.json @@ -18,7 +18,7 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Objects bound to the InputObject parameter are optional input for the script block passed to the Expression parameter. Inside the script block, `$_` can be used to reference the current object in the pipeline." + "description": "Objects bound to the InputObject parameter are optional input for the scriptblock passed to the Expression parameter. Inside the scriptblock, `$_` can be used to reference the current object in the pipeline." }, { "name": [ @@ -197,7 +197,7 @@ "description": "Specifies the expression that is being timed. Enclose the expression in braces (`{}`)." } ], - "description": "Measures the time it takes to run script blocks and cmdlets.", + "description": "Measures the time it takes to run scriptblocks and cmdlets.", "parserDirectives": { "flagsArePosixNoncompliant": true, "flagsMatchUniquePrefix": true, diff --git a/command-signatures/json/autogenerated/powershell/measure-object.json b/command-signatures/json/autogenerated/powershell/measure-object.json index 5f9e053d..c14666ee 100644 --- a/command-signatures/json/autogenerated/powershell/measure-object.json +++ b/command-signatures/json/autogenerated/powershell/measure-object.json @@ -11,7 +11,7 @@ }, { "name": "-Character", - "description": "Indicates that the cmdlet counts the number of characters in the input objects.\n" + "description": "Indicates that the cmdlet counts the number of characters in the input objects." }, { "name": "-IgnoreWhiteSpace", @@ -24,11 +24,11 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies the objects to be measured. Enter a variable that contains the objects, or type a command or expression that gets the objects.\n" + "description": "Specifies the objects to be measured. Enter a variable that contains the objects, or type a command or expression that gets the objects." }, { "name": "-Line", - "description": "Indicates that the cmdlet counts the number of lines in the input objects.\n" + "description": "Indicates that the cmdlet counts the number of lines in the input objects." }, { "name": "-Maximum", @@ -45,7 +45,7 @@ "name": "Microsoft.PowerShell.Commands.PSPropertyExpression[]" } ], - "description": "Specifies one or more properties to measure. If you do not specify any other measures, `Measure-Object` counts the objects that have the properties you specify.\n" + "description": "Specifies one or more properties to measure. If you do not specify any other measures, `Measure-Object` counts the objects that have the properties you specify." }, { "name": "-StandardDeviation", @@ -57,7 +57,7 @@ }, { "name": "-Word", - "description": "Indicates that the cmdlet counts the number of words in the input objects.\n" + "description": "Indicates that the cmdlet counts the number of words in the input objects." }, { "name": [ @@ -233,7 +233,7 @@ "args": [ { "name": "-Property", - "description": "Specifies one or more properties to measure. If you do not specify any other measures, `Measure-Object` counts the objects that have the properties you specify.\n" + "description": "Specifies one or more properties to measure. If you do not specify any other measures, `Measure-Object` counts the objects that have the properties you specify." } ], "description": "Calculates the numeric properties of objects, and the characters, words, and lines in string objects, such as files of text.", diff --git a/command-signatures/json/autogenerated/powershell/mount-appxvolume.json b/command-signatures/json/autogenerated/powershell/mount-appxvolume.json new file mode 100644 index 00000000..69f13c14 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/mount-appxvolume.json @@ -0,0 +1,207 @@ +{ + "name": "Mount-AppxVolume", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Volume", + "args": [ + { + "name": "AppxVolume[]" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Mount-AppxVolume [-Volume] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/mount-windowsimage.json b/command-signatures/json/autogenerated/powershell/mount-windowsimage.json new file mode 100644 index 00000000..cfc1b3e0 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/mount-windowsimage.json @@ -0,0 +1,290 @@ +{ + "name": "Mount-WindowsImage", + "options": [ + { + "name": "-CheckIntegrity", + "description": "Detects and tracks .wim file corruption when used with the Dismount-WindowsImage or Save-WindowsImage cmdlet. *CheckIntegrity* stops the operation if DISM detects that the .wim file is corrupted when used with the Mount-WindowsImage cmdlet. The *CheckIntegrity* parameter does not apply to virtual hard disk (VHD) files." + }, + { + "name": "-ImagePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location of the WIM or VHD file containing the Windows image you want to mount." + }, + { + "name": "-Index", + "args": [ + { + "name": "UInt32" + } + ], + "isRequired": true, + "description": "Specifies the index number of a Windows image in a WIM or VHD file. For a VHD file, the *Index* must be 1." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Name", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the name of an image in a WIM or VHD file." + }, + { + "name": "-Optimize", + "description": "Reduces the amount of time it takes to initially mount the image. However, processes that are ordinarily performed during a mount will instead be completed the first time that you access a directory. As a result, there may be an increase in the time that is required to access a directory for the first time after mounting an image using the *Optimize* parameter." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location on your local computer where you want to mount the Windows image." + }, + { + "name": "-ReadOnly", + "description": "Specifies that the image should be mounted with read-only permissions." + }, + { + "name": "-Remount", + "isRequired": true, + "description": "Mounts an image in a WIM or VHD file that was already mounted at the specified *Path*, but has become inaccessible for servicing." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SupportEa", + "description": "Applies an image with extended attributes." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Mounts a Windows image in a WIM or VHD file to a directory on the local computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/move-appxpackage.json b/command-signatures/json/autogenerated/powershell/move-appxpackage.json new file mode 100644 index 00000000..05e5e801 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/move-appxpackage.json @@ -0,0 +1,219 @@ +{ + "name": "Move-AppxPackage", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Package", + "args": [ + { + "name": "string[]" + } + ], + "isRequired": true + }, + { + "name": "-Volume", + "args": [ + { + "name": "AppxVolume" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Package" + }, + { + "name": "-Volume" + } + ], + "description": "Move-AppxPackage [-Package] [-Volume] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/move-item.json b/command-signatures/json/autogenerated/powershell/move-item.json index 4e08c29c..435b9202 100644 --- a/command-signatures/json/autogenerated/powershell/move-item.json +++ b/command-signatures/json/autogenerated/powershell/move-item.json @@ -1,24 +1,30 @@ { "name": "Move-Item", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Destination", "args": [ { - "name": "System.String", - "default": "Current directory" + "name": "System.String" } ], - "description": "Specifies the path to the location where the items are being moved. The default is the current directory. Wildcards aren't permitted.\n" + "description": "Specifies the path to the location where the items are being moved. The default is the current directory. Wildcards aren't permitted." }, { "name": "-Exclude", @@ -27,7 +33,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -36,11 +42,11 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Force", - "description": "Forces the command to run without asking for user confirmation. Implementation varies from provider to provider. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md)." + "description": "Forces the command to run without asking for user confirmation. Implementation varies from provider to provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md)." }, { "name": "-Include", @@ -49,7 +55,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -63,7 +69,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks (`'`). Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks (`'`). Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-PassThru", @@ -73,20 +79,12 @@ "name": "-Path", "args": [ { - "name": "System.String[]", - "default": "Current directory" + "name": "System.String[]" } ], "isRequired": true, "description": "Specifies the path to the current location of the items. The default is the current directory. Wildcard characters are permitted." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", @@ -272,7 +270,7 @@ }, { "name": "-Destination", - "description": "Specifies the path to the location where the items are being moved. The default is the current directory. Wildcards aren't permitted.\n" + "description": "Specifies the path to the location where the items are being moved. The default is the current directory. Wildcards aren't permitted." } ], "description": "Moves an item from one location to another.", diff --git a/command-signatures/json/autogenerated/powershell/move-itemproperty.json b/command-signatures/json/autogenerated/powershell/move-itemproperty.json index 4cb2305e..85d378e5 100644 --- a/command-signatures/json/autogenerated/powershell/move-itemproperty.json +++ b/command-signatures/json/autogenerated/powershell/move-itemproperty.json @@ -1,14 +1,21 @@ { "name": "Move-ItemProperty", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Destination", @@ -27,7 +34,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -36,11 +43,11 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Force", - "description": "Forces the command to run without asking for user confirmation. Implementation varies from provider to provider. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md)." + "description": "Forces the command to run without asking for user confirmation. Implementation varies from provider to provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md)." }, { "name": "-Include", @@ -49,7 +56,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -63,7 +70,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": [ @@ -92,13 +99,6 @@ "isRequired": true, "description": "Specifies the path to the current location of the property. Wildcard characters are permitted." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/new-alias.json b/command-signatures/json/autogenerated/powershell/new-alias.json index 1186e260..aa23d717 100644 --- a/command-signatures/json/autogenerated/powershell/new-alias.json +++ b/command-signatures/json/autogenerated/powershell/new-alias.json @@ -1,6 +1,13 @@ { "name": "New-Alias", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Description", "args": [ @@ -31,28 +38,27 @@ "name": "System.Management.Automation.ScopedItemOptions", "suggestions": [ { - "name": "None" + "name": "AllScope" }, { - "name": "ReadOnly" + "name": "Constant" }, { - "name": "Constant" + "name": "None" }, { "name": "Private" }, { - "name": "AllScope" + "name": "ReadOnly" }, { "name": "Unspecified" } - ], - "default": "[System.Management.Automation.ScopedItemOptions]::None" + ] } ], - "description": "Specifies the value of the Options property of the alias. Valid values are:\n" + "description": "Specifies the value of the Options property of the alias. Valid values are:" }, { "name": "-PassThru", @@ -65,7 +71,7 @@ "name": "System.String" } ], - "description": "Specifies the scope of the new alias. The acceptable values for this parameter are:\n" + "description": "Specifies the scope of the new alias. The acceptable values for this parameter are:" }, { "name": "-Value", @@ -77,13 +83,6 @@ "isRequired": true, "description": "Specifies the name of the cmdlet or command element that is being aliased." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/new-bcdentry.json b/command-signatures/json/autogenerated/powershell/new-bcdentry.json new file mode 100644 index 00000000..bc1e347c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-bcdentry.json @@ -0,0 +1,264 @@ +{ + "name": "New-BcdEntry", + "options": [ + { + "name": "-Application", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Application Description }}" + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Description", + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill Description Description }}" + }, + { + "name": "-Device", + "isRequired": true, + "description": "{{ Fill Device Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Inherit", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Inherit Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Id", + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-bcdstore.json b/command-signatures/json/autogenerated/powershell/new-bcdstore.json new file mode 100644 index 00000000..5fa85cfe --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-bcdstore.json @@ -0,0 +1,215 @@ +{ + "name": "New-BcdStore", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": "-Path", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Path Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path", + "description": "{{ Fill Path Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-certificatenotificationtask.json b/command-signatures/json/autogenerated/powershell/new-certificatenotificationtask.json new file mode 100644 index 00000000..86b2f574 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-certificatenotificationtask.json @@ -0,0 +1,256 @@ +{ + "name": "New-CertificateNotificationTask", + "options": [ + { + "name": "-Channel", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.NotificationChannel", + "suggestions": [ + { + "name": "System" + }, + { + "name": "User" + } + ] + } + ], + "isRequired": true, + "description": "Sets the channel of the CertificateServicesClient-Notifications log that will be monitored for certificate lifecycle events. The acceptable values for this parameter are:" + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the unique name for the certificate notification task. If a certificate notification task with the same name already exists, then an error is generated." + }, + { + "name": "-PSScript", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Identifies the Windows PowerShell script that will be triggered by the certificate notification task. The script will be launched with the NonInteractive parameter." + }, + { + "name": "-RunTaskForExistingCertificates", + "description": "Generates a replacement notification for any certificate in the My store that has been replaced in the past. For the notification to be generated both certificates must be present in the store. This parameter can only be used with the `Replace` type." + }, + { + "name": "-Type", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.CertificateNotificationType", + "suggestions": [ + { + "name": "Replace" + }, + { + "name": "Expire" + } + ] + } + ], + "isRequired": true, + "description": "Specifies the type of events that will trigger certificate notifications. The acceptable values for this parameter are:" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Creates a new task in the Task Scheduler that will be triggered when a certificate is replaced, expired, or about to expired.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-ciminstance.json b/command-signatures/json/autogenerated/powershell/new-ciminstance.json new file mode 100644 index 00000000..c14a651e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-ciminstance.json @@ -0,0 +1,306 @@ +{ + "name": "New-CimInstance", + "options": [ + { + "name": "-CimClass", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimClass" + } + ], + "isRequired": true, + "description": "Specifies a CIM class object that represents the type of the instance. Use the `Get-CimClass` cmdlet to retrieve the class declaration from a computer. Using this parameter results in better client side schema validations." + }, + { + "name": "-CimSession", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimSession[]" + } + ], + "isRequired": true, + "description": "Runs the command using the specified CIM session. Enter a variable that contains the CIM session, or a command that creates or gets the CIM session, such as the `New-CimSession` or `Get-CimSession` cmdlets. For more information, see [about_CimSession](../Microsoft.PowerShell.Core/About/about_CimSession.md)." + }, + { + "name": "-ClassName", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the CIM class of which the operation creates an instance. NOTE: You can use tab completion to browse the list of classes, because PowerShell gets a list of classes from the local WMI server to provide a list of class names." + }, + { + "name": [ + "-ClientOnly", + "-Local" + ], + "description": "Indicates that the instance is only created in PowerShell without going to the CIM server. You can use this parameter to create an in-memory CIM instance for use in subsequent PowerShell operations." + }, + { + "name": [ + "-ComputerName", + "-CN", + "-ServerName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the name of the computer on which you want to run the CIM operation. You can specify a fully qualified domain name (FQDN), a NetBIOS name, or an IP address." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Key", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the properties that are used as keys. CimSession and ComputerName cannot be used when Key is specified." + }, + { + "name": "-Namespace", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the namespace of the class for the new instance. The default namespace is root/CIMV2. You can use tab completion to browse the list of namespaces, because PowerShell gets a list of namespaces from the local WMI server to provide the list of namespaces." + }, + { + "name": [ + "-OperationTimeoutSec", + "-OT" + ], + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "Specifies the amount of time that the cmdlet waits for a response from the CIM server. By default, the value of this parameter is 0, which means that the cmdlet uses the default timeout value for the server. If the OperationTimeoutSec parameter is set to a value less than the robust connection retry timeout of 3 minutes, network failures that last more than the value of the OperationTimeoutSec parameter are not recoverable, because the operation on the server times out before the client can reconnect." + }, + { + "name": [ + "-Property", + "-Arguments" + ], + "args": [ + { + "name": "System.Collections.IDictionary" + } + ], + "description": "Specifies the properties of the CIM instance using a hash table (name-value pairs)." + }, + { + "name": "-ResourceUri", + "args": [ + { + "name": "System.Uri" + } + ], + "isRequired": true, + "description": "Specifies the resource uniform resource identifier (URI) of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-CimClass-Or-ClassName" + }, + { + "name": "-Property", + "description": "Specifies the properties of the CIM instance using a hash table (name-value pairs)." + } + ], + "description": "Creates a CIM instance.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-cimsession.json b/command-signatures/json/autogenerated/powershell/new-cimsession.json new file mode 100644 index 00000000..6b9bf87a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-cimsession.json @@ -0,0 +1,297 @@ +{ + "name": "New-CimSession", + "options": [ + { + "name": "-Authentication", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.Options.PasswordAuthenticationMechanism", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "CredSsp" + }, + { + "name": "Default" + }, + { + "name": "Digest" + }, + { + "name": "Kerberos" + }, + { + "name": "Negotiate" + }, + { + "name": "NtlmDomain" + } + ] + } + ], + "description": "Specifies the authentication type used for the user's credentials. The acceptable values for this parameter are:" + }, + { + "name": "-CertificateThumbprint", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the digital public key certificate (X.509) of a user account that has permission to perform this action. Enter the certificate thumbprint of the certificate." + }, + { + "name": [ + "-ComputerName", + "-CN", + "-ServerName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the name of the computer to which to create the CIM session. Specify either a single computer name, or multiple computer names separated by a comma." + }, + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to perform this action. If Credential is not specified, the current user account is used." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a friendly name for the CIM session." + }, + { + "name": [ + "-OperationTimeoutSec", + "-OT" + ], + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "Duration for which the cmdlet waits for a response from the server." + }, + { + "name": "-Port", + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "Specifies the network port on the remote computer that is used for this connection. To connect to a remote computer, the remote computer must be listening on the port that the connection uses. The default ports are 5985 (the WinRM port for HTTP) and 5986 (the WinRM port for HTTPS)." + }, + { + "name": "-SessionOption", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.Options.CimSessionOptions" + } + ], + "description": "Sets advanced options for the new CIM session. Enter the name of a CimSessionOption object created using the [`New-CimSessionOption`](New-CimSessionOption.md) cmdlet." + }, + { + "name": "-SkipTestConnection", + "description": "By default, the `New-CimSession` cmdlet establishes a connection with a remote WS-Management endpoint for two reasons: to verify that the remote server is listening on the port number that is specified using the Port parameter, and to verify the specified account credentials. The verification is accomplished using a standard WS-Identity operation. You can add the SkipTestConnection `[switch]` parameter if the remote WS-Management endpoint cannot use WS-Identify, or to reduce some data transmission time." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ComputerName", + "description": "Specifies the name of the computer to which to create the CIM session. Specify either a single computer name, or multiple computer names separated by a comma." + }, + { + "name": "-Credential", + "description": "Specifies a user account that has permission to perform this action. If Credential is not specified, the current user account is used." + } + ], + "description": "Creates a CIM session.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-cimsessionoption.json b/command-signatures/json/autogenerated/powershell/new-cimsessionoption.json new file mode 100644 index 00000000..aa06da1e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-cimsessionoption.json @@ -0,0 +1,406 @@ +{ + "name": "New-CimSessionOption", + "options": [ + { + "name": "-Culture", + "args": [ + { + "name": "System.Globalization.CultureInfo" + } + ], + "description": "Specifies the user interface culture to use for the CIM session. Specify the value for this parameter using one of the following formats:" + }, + { + "name": "-EncodePortInServicePrincipalName", + "description": "Indicates that the Kerberos connection is connecting to a service whose service principal name (SPN) includes the service port number. This type of connection is not common." + }, + { + "name": "-Encoding", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.Options.PacketEncoding", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "Utf16" + }, + { + "name": "Utf8" + } + ] + } + ], + "description": "Specifies the encoding used for the WsMan protocol. The acceptable values for this parameter are: Default, Utf8, or Utf16." + }, + { + "name": "-HttpPrefix", + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the part of the HTTP URL after the computer name and port number. Changing this is not common. By default, the value of this parameter is /wsman." + }, + { + "name": "-Impersonation", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.Options.ImpersonationType", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "Delegate" + }, + { + "name": "Identify" + }, + { + "name": "Impersonate" + }, + { + "name": "None" + } + ] + } + ], + "description": "Creates a DCOM session to Windows Management Instrumentation (WMI) using impersonation." + }, + { + "name": "-MaxEnvelopeSizeKB", + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "Specifies the size limit of WsMan XML messages for either direction." + }, + { + "name": "-NoEncryption", + "description": "Specifies that data encryption is turned off." + }, + { + "name": "-PacketIntegrity", + "description": "Specifies that the DCOM session created to WMI uses the Component Object Model (COM) _PacketIntegrity_ functionality. By default, all CIM sessions created using DCOM have the PacketIntegrity parameter set to True." + }, + { + "name": "-PacketPrivacy", + "description": "Creates a DCOM session to WMI using the COM _PacketPrivacy_. By default, all CIM sessions created using DCOM have the PacketPrivacy parameter set to true." + }, + { + "name": "-Protocol", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimCmdlets.ProtocolType", + "suggestions": [ + { + "name": "Dcom" + }, + { + "name": "Default" + }, + { + "name": "Wsman" + } + ] + } + ], + "isRequired": true, + "description": "Specifies the protocol to use. The acceptable values for this parameter are: Dcom, Default, or Wsman." + }, + { + "name": "-ProxyAuthentication", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.Options.PasswordAuthenticationMechanism", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "CredSsp" + }, + { + "name": "Default" + }, + { + "name": "Digest" + }, + { + "name": "Kerberos" + }, + { + "name": "Negotiate" + }, + { + "name": "NtlmDomain" + } + ] + } + ], + "description": "Specifies the authentication method to use for proxy resolution. The acceptable values for this parameter are: Default, Digest, Negotiate, Basic, Kerberos, NtlmDomain, or CredSsp." + }, + { + "name": "-ProxyCertificateThumbprint", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the (x.509) digital public key certificate of a user account for proxy authentication. Enter the certificate thumbprint of the certificate. Certificates are used in client certificate-based authentication. They can only be mapped to local user accounts and they do not work with domain accounts." + }, + { + "name": "-ProxyCredential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies the credentials to use for proxy authentication. Enter one of the following:" + }, + { + "name": "-ProxyType", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.Options.ProxyType", + "suggestions": [ + { + "name": "Auto" + }, + { + "name": "InternetExplorer" + }, + { + "name": "None" + }, + { + "name": "WinHttp" + } + ] + } + ], + "description": "Specifies the host name resolution mechanism to use. The acceptable values for this parameter are: None, WinHttp, Auto, or InternetExplorer." + }, + { + "name": "-SkipCACheck", + "description": "Indicates that when connecting over HTTPS, the client does not validate that the server certificate is signed by a trusted certification authority (CA)." + }, + { + "name": "-SkipCNCheck", + "description": "Indicates that the certificate common name (CN) of the server does not need to match the hostname of the server. Use this parameter for remote operations only with trusted computers that use the HTTPS protocol." + }, + { + "name": "-SkipRevocationCheck", + "description": "Indicates that the revocation check for server certificates is skipped. Use this parameter only for trusted computers." + }, + { + "name": "-UICulture", + "args": [ + { + "name": "System.Globalization.CultureInfo" + } + ], + "description": "Specifies the user interface culture to use for the CIM session. Specify the value for this parameter using one of the following formats:" + }, + { + "name": "-UseSsl", + "description": "Indicates that SSL should be used to establish a connection to the remote computer. By default, SSL is not used. WsMan encrypts all content that is transmitted over the network, even when using HTTP." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Protocol", + "description": "Specifies the protocol to use. The acceptable values for this parameter are: Dcom, Default, or Wsman.", + "suggestions": [ + { + "name": "Dcom" + }, + { + "name": "Default" + }, + { + "name": "Wsman" + } + ] + } + ], + "description": "Specifies advanced options for the New-CimSession cmdlet.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-dtcdiagnostictransaction.json b/command-signatures/json/autogenerated/powershell/new-dtcdiagnostictransaction.json new file mode 100644 index 00000000..f85413bf --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-dtcdiagnostictransaction.json @@ -0,0 +1,251 @@ +{ + "name": "New-DtcDiagnosticTransaction", + "options": [ + { + "name": "-IsolationLevel", + "args": [ + { + "name": "IsolationLevel", + "suggestions": [ + { + "name": "Serializable" + }, + { + "name": "RepeatableRead" + }, + { + "name": "ReadCommitted" + }, + { + "name": "ReadUncommitted" + }, + { + "name": "Snapshot" + }, + { + "name": "Chaos" + }, + { + "name": "Unspecified" + } + ] + } + ] + }, + { + "name": "-Timeout", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Timeout" + }, + { + "name": "-IsolationLevel", + "suggestions": [ + { + "name": "Serializable" + }, + { + "name": "RepeatableRead" + }, + { + "name": "ReadCommitted" + }, + { + "name": "ReadUncommitted" + }, + { + "name": "Snapshot" + }, + { + "name": "Chaos" + }, + { + "name": "Unspecified" + } + ] + } + ], + "description": "New-DtcDiagnosticTransaction [[-Timeout] ] [[-IsolationLevel] ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-event.json b/command-signatures/json/autogenerated/powershell/new-event.json index 5f62378b..a2010d20 100644 --- a/command-signatures/json/autogenerated/powershell/new-event.json +++ b/command-signatures/json/autogenerated/powershell/new-event.json @@ -36,7 +36,7 @@ } ], "isRequired": true, - "description": "Specifies a name for the new event. This parameter is required, and it must be unique in the session.\n" + "description": "Specifies a name for the new event. This parameter is required, and it must be unique in the session." }, { "name": [ @@ -212,7 +212,7 @@ "args": [ { "name": "-SourceIdentifier", - "description": "Specifies a name for the new event. This parameter is required, and it must be unique in the session.\n" + "description": "Specifies a name for the new event. This parameter is required, and it must be unique in the session." }, { "name": "-Sender", diff --git a/command-signatures/json/autogenerated/powershell/new-eventlog.json b/command-signatures/json/autogenerated/powershell/new-eventlog.json new file mode 100644 index 00000000..35b74ceb --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-eventlog.json @@ -0,0 +1,260 @@ +{ + "name": "New-EventLog", + "options": [ + { + "name": [ + "-CategoryResourceFile", + "-CRF" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-ComputerName", + "-CN" + ], + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-LogName", + "-LN" + ], + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-MessageResourceFile", + "-MRF" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-ParameterResourceFile", + "-PRF" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Source", + "-SRC" + ], + "args": [ + { + "name": "string[]" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-LogName" + }, + { + "name": "-Source" + }, + { + "name": "-ComputerName" + } + ], + "description": "New-EventLog [-LogName] [-Source] [[-ComputerName] ] [-CategoryResourceFile ] [-MessageResourceFile ] [-ParameterResourceFile ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-filecatalog.json b/command-signatures/json/autogenerated/powershell/new-filecatalog.json new file mode 100644 index 00000000..0398c580 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-filecatalog.json @@ -0,0 +1,233 @@ +{ + "name": "New-FileCatalog", + "options": [ + { + "name": "-CatalogFilePath", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "The location and name of the catalog file (`.cat`) you are creating. If you specify only a folder path, the command creates a file named `catalog.cat` in that location." + }, + { + "name": "-CatalogVersion", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Accepts `1.0` or `2.0` as possible values for specifying the catalog version. `1.0` should be avoided whenever possible because it uses the insecure SHA-1 hash algorithm. Version `2.0` uses the secure SHA-256 algorithm." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Path", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Accepts a path or array of paths to files or folders that should be included in the catalog file. When you specify a folder, the command enumerates the contents of the folder recursively to include all subfolders and their contents. The catalog file contains relative paths to the files included in the catalog." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-CatalogFilePath", + "description": "The location and name of the catalog file (`.cat`) you are creating. If you specify only a folder path, the command creates a file named `catalog.cat` in that location." + }, + { + "name": "-Path", + "description": "Accepts a path or array of paths to files or folders that should be included in the catalog file. When you specify a folder, the command enumerates the contents of the folder recursively to include all subfolders and their contents. The catalog file contains relative paths to the files included in the catalog." + } + ], + "description": "Creates a Windows catalog file containing cryptographic hashes for files and folders in the specified paths.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-guid.json b/command-signatures/json/autogenerated/powershell/new-guid.json index 52830508..b71b5636 100644 --- a/command-signatures/json/autogenerated/powershell/new-guid.json +++ b/command-signatures/json/autogenerated/powershell/new-guid.json @@ -1,6 +1,19 @@ { "name": "New-Guid", "options": [ + { + "name": "-Empty", + "description": "Indicates that this cmdlet creates an empty GUID. An empty GUID has all zeros in its string." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "System.String" + } + ], + "description": "This parameter accepts a string representing a GUID and converts it to a GUID object." + }, { "name": [ "-Debug", diff --git a/command-signatures/json/autogenerated/powershell/new-item.json b/command-signatures/json/autogenerated/powershell/new-item.json index feaf6c40..f83c9f7c 100644 --- a/command-signatures/json/autogenerated/powershell/new-item.json +++ b/command-signatures/json/autogenerated/powershell/new-item.json @@ -8,7 +8,7 @@ "name": "System.String" } ], - "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows." }, { "name": "-Authentication", @@ -17,7 +17,7 @@ "name": "Microsoft.WSMan.Management.AuthenticationMechanism" } ], - "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows." }, { "name": "-CertificateThumbprint", @@ -26,7 +26,14 @@ "name": "System.String" } ], - "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-ConnectionURI", @@ -36,20 +43,20 @@ } ], "isRequired": true, - "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows." }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter isn't supported by any providers installed with PowerShell. To impersonate another > user or elevate your credentials when running this cmdlet, use `Invoke-Command`." }, { "name": "-Force", - "description": "Forces this cmdlet to create an item that writes over an existing read-only item. Implementation varies from provider to provider. Even using the Force parameter, the cmdlet can't override security restrictions.\n" + "description": "Forces this cmdlet to create an item that writes over an existing read-only item. Implementation varies from provider to provider. Even using the Force parameter, the cmdlet can't override security restrictions." }, { "name": [ @@ -61,7 +68,7 @@ "name": "System.String" } ], - "description": "Specifies the provider-specified type of the new item. The available values of this parameter depend on the current provider you are using.\n" + "description": "Specifies the provider-specified type of the new item. The available values of this parameter depend on the current provider you are using." }, { "name": "-Name", @@ -80,29 +87,26 @@ "name": "System.Management.Automation.ScopedItemOptions" } ], - "description": "This is a dynamic parameter made available by the Alias provider. For more information, see New-Alias (../Microsoft.PowerShell.Utility/New-Alias.md).\n" + "description": "This is a dynamic parameter made available by the Alias provider. For more information, see [New-Alias](../Microsoft.PowerShell.Utility/New-Alias.md)." }, { - "name": [ - "-OptionSet", - "-OS" - ], + "name": "-OptionSet", "args": [ { "name": "System.Collections.Hashtable" } ], - "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows." }, { "name": "-Path", "args": [ { - "name": "System.String[]", - "default": "Current location" + "name": "System.String[]" } ], - "description": "Specifies the path of the location of the new item. The default is the current location when Path is omitted. You can specify the name of the new item in Name , or include it in Path . Items names passed using the Name parameter are created relative to the value of the Path parameter.\n" + "isRequired": true, + "description": "Specifies the path of the location of the new item. The default is the current location when Path is omitted. You can specify the name of the new item in Name, or include it in Path. Items names passed using the Name parameter are created relative to the value of the Path parameter." }, { "name": "-Port", @@ -111,23 +115,21 @@ "name": "System.Int32" } ], - "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows.\n" + "isRequired": true, + "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows." }, { - "name": [ - "-SessionOption", - "-SO" - ], + "name": "-SessionOption", "args": [ { "name": "Microsoft.WSMan.Management.SessionOption" } ], - "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows." }, { "name": "-UseSSL", - "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the WSMan provider. The WSMan provider and this parameter are only available on Windows." }, { "name": [ @@ -141,13 +143,6 @@ ], "description": "Specifies the value of the new item. You can also pipe a value to `New-Item`." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", @@ -329,7 +324,7 @@ "args": [ { "name": "-Path", - "description": "Specifies the path of the location of the new item. The default is the current location when Path is omitted. You can specify the name of the new item in Name , or include it in Path . Items names passed using the Name parameter are created relative to the value of the Path parameter.\n" + "description": "Specifies the path of the location of the new item. The default is the current location when Path is omitted. You can specify the name of the new item in Name, or include it in Path. Items names passed using the Name parameter are created relative to the value of the Path parameter." } ], "description": "Creates a new item.", diff --git a/command-signatures/json/autogenerated/powershell/new-itemproperty.json b/command-signatures/json/autogenerated/powershell/new-itemproperty.json index 6d43ddfc..5e69b56f 100644 --- a/command-signatures/json/autogenerated/powershell/new-itemproperty.json +++ b/command-signatures/json/autogenerated/powershell/new-itemproperty.json @@ -1,15 +1,21 @@ { "name": "New-ItemProperty", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to perform this action. The default is the current user.\n" + "description": "Specifies a user account that has permission to perform this action. The default is the current user." }, { "name": "-Exclude", @@ -18,7 +24,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -27,11 +33,11 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Force", - "description": "Forces the cmdlet to create a property on an object that cannot otherwise be accessed by the user. Implementation varies from provider to provider. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md)." + "description": "Forces the cmdlet to create a property on an object that cannot otherwise be accessed by the user. Implementation varies from provider to provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md)." }, { "name": "-Include", @@ -40,7 +46,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -54,7 +60,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks (`'`). Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks (`'`). Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": [ @@ -86,10 +92,10 @@ ], "args": [ { - "name": "Microsoft.Win32.RegistryValueKind" + "name": "System.String" } ], - "description": "This is a dynamic parameter made available by the Registry provider. The Registry provider and this parameter are only available on Windows.\n" + "description": "Specifies the type of property that this cmdlet adds. The acceptable values for this parameter are:" }, { "name": "-Value", @@ -100,13 +106,6 @@ ], "description": "Specifies the property value. If the property is a registry entry, this parameter specifies the value of the entry." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/new-jobtrigger.json b/command-signatures/json/autogenerated/powershell/new-jobtrigger.json new file mode 100644 index 00000000..c89f58ff --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-jobtrigger.json @@ -0,0 +1,182 @@ +{ + "name": "New-JobTrigger", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "New-JobTrigger", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-localgroup.json b/command-signatures/json/autogenerated/powershell/new-localgroup.json new file mode 100644 index 00000000..9e34fa7d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-localgroup.json @@ -0,0 +1,220 @@ +{ + "name": "New-LocalGroup", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Description", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a comment for the group. The maximum length is 256 characters." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies a name for the group. The maximum length is 48 characters." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies a name for the group. The maximum length is 48 characters." + } + ], + "description": "Creates a local security group.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-localuser.json b/command-signatures/json/autogenerated/powershell/new-localuser.json new file mode 100644 index 00000000..549e5d45 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-localuser.json @@ -0,0 +1,269 @@ +{ + "name": "New-LocalUser", + "options": [ + { + "name": "-AccountExpires", + "args": [ + { + "name": "System.DateTime" + } + ], + "description": "Specifies when the user account expires. You can use the `Get-Date` cmdlet to get a DateTime object. If you don't specify this parameter, the account doesn't expire." + }, + { + "name": "-AccountNeverExpires", + "description": "Indicates that the account doesn't expire." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Description", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a comment for the user account. The maximum length is 48 characters." + }, + { + "name": "-Disabled", + "description": "Indicates that this cmdlet creates the user account as disabled." + }, + { + "name": "-FullName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the full name for the user account. The full name differs from the user name of the user account." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the user name for the user account." + }, + { + "name": "-NoPassword", + "isRequired": true, + "description": "Indicates that the user account doesn't have a password." + }, + { + "name": "-Password", + "args": [ + { + "name": "System.Security.SecureString" + } + ], + "isRequired": true, + "description": "Specifies a password for the user account. You can use `Read-Host -AsSecureString`, `Get-Credential`, or `ConvertTo-SecureString` to create a SecureString object for the password." + }, + { + "name": "-PasswordNeverExpires", + "description": "Indicates whether the new user's password expires." + }, + { + "name": "-UserMayNotChangePassword", + "description": "Indicates that the user can't change the password on the user account." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the user name for the user account." + } + ], + "description": "Creates a local user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-module.json b/command-signatures/json/autogenerated/powershell/new-module.json index 3731a4c6..cb938b36 100644 --- a/command-signatures/json/autogenerated/powershell/new-module.json +++ b/command-signatures/json/autogenerated/powershell/new-module.json @@ -11,11 +11,11 @@ "name": "System.Object[]" } ], - "description": "Specifies an array of arguments which are parameter values that are passed to the script block. For more information about the behavior of ArgumentList , see about_Splatting (about/about_Splatting.md#splatting-with-arrays)." + "description": "Specifies an array of arguments which are parameter values that are passed to the scriptblock. For more information about the behavior of ArgumentList, see [about_Splatting](about/about_Splatting.md#splatting-with-arrays)." }, { "name": "-AsCustomObject", - "description": "Indicates that this cmdlet returns a custom object that represents the dynamic module. The module members are implemented as script methods of the custom object, but they are not imported into the session. You can save the custom object in a variable and use dot notation to invoke the members.\n" + "description": "Indicates that this cmdlet returns a custom object that represents the dynamic module. The module members are implemented as script methods of the custom object, but they are not imported into the session. You can save the custom object in a variable and use dot notation to invoke the members." }, { "name": "-Cmdlet", @@ -24,7 +24,7 @@ "name": "System.String[]" } ], - "description": "Specifies an array of cmdlets that this cmdlet exports from the module into the current session. Enter a comma-separated list of cmdlets. Wildcard characters are permitted. By default, all cmdlets in the module are exported.\n" + "description": "Specifies an array of cmdlets that this cmdlet exports from the module into the current session. Enter a comma-separated list of cmdlets. Wildcard characters are permitted. By default, all cmdlets in the module are exported." }, { "name": "-Function", @@ -43,11 +43,11 @@ } ], "isRequired": true, - "description": "Specifies a name for the new module. You can also pipe a module name to New-Module.\n" + "description": "Specifies a name for the new module. You can also pipe a module name to New-Module." }, { "name": "-ReturnResult", - "description": "Indicates that this cmdlet runs the script block and returns the script block results instead of returning a module object." + "description": "Indicates that this cmdlet runs the scriptblock and returns the scriptblock results instead of returning a module object." }, { "name": "-ScriptBlock", @@ -57,7 +57,7 @@ } ], "isRequired": true, - "description": "Specifies the contents of the dynamic module. Enclose the contents in braces (`{}`) to create a script block. This parameter is required." + "description": "Specifies the contents of the dynamic module. Enclose the contents in braces (`{}`) to create a scriptblock. This parameter is required." }, { "name": [ @@ -233,11 +233,11 @@ "args": [ { "name": "-Name", - "description": "Specifies a name for the new module. You can also pipe a module name to New-Module.\n" + "description": "Specifies a name for the new module. You can also pipe a module name to New-Module." }, { "name": "-ScriptBlock", - "description": "Specifies the contents of the dynamic module. Enclose the contents in braces (`{}`) to create a script block. This parameter is required." + "description": "Specifies the contents of the dynamic module. Enclose the contents in braces (`{}`) to create a scriptblock. This parameter is required." } ], "description": "Creates a new dynamic module that exists only in memory.", diff --git a/command-signatures/json/autogenerated/powershell/new-modulemanifest.json b/command-signatures/json/autogenerated/powershell/new-modulemanifest.json index ebdf61ea..bfbef358 100644 --- a/command-signatures/json/autogenerated/powershell/new-modulemanifest.json +++ b/command-signatures/json/autogenerated/powershell/new-modulemanifest.json @@ -5,21 +5,19 @@ "name": "-AliasesToExport", "args": [ { - "name": "System.String[]", - "default": "* (all)" + "name": "System.String[]" } ], - "description": "Specifies the aliases that the module exports. Wildcards are permitted.\n" + "description": "Specifies the aliases that the module exports. Wildcards are permitted." }, { "name": "-Author", "args": [ { - "name": "System.String", - "default": "Name of the current user" + "name": "System.String" } ], - "description": "Specifies the module author.\n" + "description": "Specifies the module author." }, { "name": "-ClrVersion", @@ -28,27 +26,25 @@ "name": "System.Version" } ], - "description": "Specifies the minimum version of the Common Language Runtime (CLR) of the Microsoft .NET Framework that the module requires.\n" + "description": "Specifies the minimum version of the Common Language Runtime (CLR) of the Microsoft .NET Framework that the module requires." }, { "name": "-CmdletsToExport", "args": [ { - "name": "System.String[]", - "default": "* (all)" + "name": "System.String[]" } ], - "description": "Specifies the cmdlets that the module exports. Wildcards are permitted.\n" + "description": "Specifies the cmdlets that the module exports. Wildcards are permitted." }, { "name": "-CompanyName", "args": [ { - "name": "System.String", - "default": "\"Unknown\"" + "name": "System.String" } ], - "description": "Identifies the company or vendor who created the module.\n" + "description": "Identifies the company or vendor who created the module." }, { "name": "-CompatiblePSEditions", @@ -57,25 +53,31 @@ "name": "System.String[]", "suggestions": [ { - "name": "Desktop" + "name": "Core" }, { - "name": "Core" + "name": "Desktop" } ] } ], - "description": "Specifies the module's compatible PSEditions. For information about PSEdition, see Modules with compatible PowerShell Editions (/powershell/gallery/concepts/module-psedition-support)." + "description": "Specifies the module's compatible PSEditions. For information about PSEdition, see [Modules with compatible PowerShell Editions](/powershell/gallery/concepts/module-psedition-support)." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-Copyright", "args": [ { - "name": "System.String", - "default": "(c) . All rights reserved." + "name": "System.String" } ], - "description": "Specifies a copyright statement for the module.\n" + "description": "Specifies a copyright statement for the module." }, { "name": "-DefaultCommandPrefix", @@ -84,7 +86,7 @@ "name": "System.String" } ], - "description": "Specifies a prefix that is prepended to the nouns of all commands in the module when they're imported into a session. Enter a prefix string. Prefixes prevent command name conflicts in a user's session.\n" + "description": "Specifies a prefix that is prepended to the nouns of all commands in the module when they're imported into a session. Enter a prefix string. Prefixes prevent command name conflicts in a user's session." }, { "name": "-Description", @@ -102,7 +104,7 @@ "name": "System.Version" } ], - "description": "Specifies the minimum version of the Microsoft .NET Framework that the module requires.\n" + "description": "Specifies the minimum version of the Microsoft .NET Framework that the module requires." }, { "name": "-DscResourcesToExport", @@ -120,7 +122,7 @@ "name": "System.String[]" } ], - "description": "A list of external modules that this module is depends on." + "description": "A list of external modules that this module is depends on. This list is only used to document the module's dependencies and is not enforced by PowerShell. It's not used by the PowerShellGet or PSResourceGet commands, or by the PowerShell Gallery." }, { "name": "-FileList", @@ -129,7 +131,7 @@ "name": "System.String[]" } ], - "description": "Specifies all items that are included in the module.\n" + "description": "Specifies all items that are included in the module." }, { "name": "-FormatsToProcess", @@ -138,27 +140,25 @@ "name": "System.String[]" } ], - "description": "Specifies the formatting files (`.ps1xml`) that run when the module is imported.\n" + "description": "Specifies the formatting files (`.ps1xml`) that run when the module is imported." }, { "name": "-FunctionsToExport", "args": [ { - "name": "System.String[]", - "default": "* (all)" + "name": "System.String[]" } ], - "description": "Specifies the functions that the module exports. Wildcards are permitted.\n" + "description": "Specifies the functions that the module exports. Wildcards are permitted." }, { "name": "-Guid", "args": [ { - "name": "System.Guid", - "default": "A GUID generated for the module" + "name": "System.Guid" } ], - "description": "Specifies a unique identifier for the module. The GUID can be used to distinguish among modules with the same name.\n" + "description": "Specifies a unique identifier for the module. The GUID can be used to distinguish among modules with the same name." }, { "name": "-HelpInfoUri", @@ -167,7 +167,7 @@ "name": "System.String" } ], - "description": "Specifies the internet address of the HelpInfo XML file for the module. Enter a Uniform Resource Identifier (URI) that begins with http or https .\n" + "description": "Specifies the internet address of the HelpInfo XML file for the module. Enter a Uniform Resource Identifier (URI) that begins with http or https." }, { "name": "-IconUri", @@ -194,17 +194,16 @@ "name": "System.Object[]" } ], - "description": "Lists all modules that are included in this module.\n" + "description": "Lists all modules that are included in this module." }, { "name": "-ModuleVersion", "args": [ { - "name": "System.Version", - "default": "1.0" + "name": "System.Version" } ], - "description": "Specifies the module's version.\n" + "description": "Specifies the module's version." }, { "name": "-NestedModules", @@ -213,7 +212,7 @@ "name": "System.Object[]" } ], - "description": "Specifies script modules (`.psm1`) and binary modules (`.dll`) that are imported into the module's session state. The files in the NestedModules key run in the order in which they're listed in the value.\n" + "description": "Specifies script modules (`.psm1`) and binary modules (`.dll`) that are imported into the module's session state. The files in the NestedModules key run in the order in which they're listed in the value." }, { "name": "-PassThru", @@ -227,7 +226,7 @@ } ], "isRequired": true, - "description": "Specifies the path and file name of the new module manifest. Enter a path and file name with a `.psd1` file name extension, such as `$pshome\\Modules\\MyModule\\MyModule.psd1`. The Path parameter is required.\n" + "description": "Specifies the path and file name of the new module manifest. Enter a path and file name with a `.psd1` file name extension, such as `$PSHOME\\Modules\\MyModule\\MyModule.psd1`. The Path parameter is required." }, { "name": "-PowerShellHostName", @@ -236,7 +235,7 @@ "name": "System.String" } ], - "description": "Specifies the name of the PowerShell host program that the module requires. Enter the name of the host program, such as Windows PowerShell ISE Host or ConsoleHost . Wildcards aren't permitted.\n" + "description": "Specifies the name of the PowerShell host program that the module requires. Enter the name of the host program, such as Windows PowerShell ISE Host or ConsoleHost. Wildcards aren't permitted." }, { "name": "-PowerShellHostVersion", @@ -281,22 +280,22 @@ "name": "System.Reflection.ProcessorArchitecture", "suggestions": [ { - "name": "None" + "name": "Amd64" }, { - "name": "MSIL" + "name": "Arm" }, { - "name": "X86" + "name": "IA64" }, { - "name": "IA64" + "name": "MSIL" }, { - "name": "Amd64" + "name": "None" }, { - "name": "Arm" + "name": "X86" } ] } @@ -328,7 +327,7 @@ "name": "System.String[]" } ], - "description": "Specifies the assembly (`.dll`) files that the module requires. Enter the assembly file names. PowerShell loads the specified assemblies before updating types or formats, importing nested modules, or importing the module file that is specified in the value of the RootModule key.\n" + "description": "Specifies the assembly (`.dll`) files that the module requires. Enter the assembly file names. PowerShell loads the specified assemblies before updating types or formats, importing nested modules, or importing the module file that is specified in the value of the RootModule key." }, { "name": "-RequiredModules", @@ -337,7 +336,7 @@ "name": "System.Object[]" } ], - "description": "Specifies modules that must be in the global session state. If the required modules aren't in the global session state, PowerShell imports them. If the required modules aren't available, the `Import-Module` command fails.\n" + "description": "Specifies modules that must be in the global session state. If the required modules aren't in the global session state, PowerShell imports them. If the required modules aren't available, the `Import-Module` command fails." }, { "name": "-RequireLicenseAcceptance", @@ -353,7 +352,7 @@ "name": "System.String" } ], - "description": "Specifies the primary or root file of the module. Enter the file name of a script (`.ps1`), a script module (`.psm1`), a module manifest(`.psd1`), an assembly (`.dll`), a cmdlet definition XML file (`.cdxml`), or a workflow (`.xaml`). When the module is imported, the members that are exported from the root module file are imported into the caller's session state.\n" + "description": "Specifies the primary or root file of the module. Enter the file name of a script (`.ps1`), a script module (`.psm1`), a module manifest(`.psd1`), an assembly (`.dll`), a cmdlet definition XML file (`.cdxml`), or a workflow (`.xaml`). When the module is imported, the members that are exported from the root module file are imported into the caller's session state." }, { "name": "-ScriptsToProcess", @@ -362,7 +361,7 @@ "name": "System.String[]" } ], - "description": "Specifies script (`.ps1`) files that run in the caller's session state when the module is imported. You can use these scripts to prepare an environment, just as you might use a login script.\n" + "description": "Specifies script (`.ps1`) files that run in the caller's session state when the module is imported. You can use these scripts to prepare an environment, just as you might use a login script." }, { "name": "-Tags", @@ -380,24 +379,16 @@ "name": "System.String[]" } ], - "description": "Specifies the type files (`.ps1xml`) that run when the module is imported.\n" + "description": "Specifies the type files (`.ps1xml`) that run when the module is imported." }, { "name": "-VariablesToExport", "args": [ { - "name": "System.String[]", - "default": "* (all)" + "name": "System.String[]" } ], - "description": "Specifies the variables that the module exports. Wildcards are permitted.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the variables that the module exports. Wildcards are permitted." }, { "name": [ @@ -580,7 +571,7 @@ "args": [ { "name": "-Path", - "description": "Specifies the path and file name of the new module manifest. Enter a path and file name with a `.psd1` file name extension, such as `$pshome\\Modules\\MyModule\\MyModule.psd1`. The Path parameter is required.\n" + "description": "Specifies the path and file name of the new module manifest. Enter a path and file name with a `.psd1` file name extension, such as `$PSHOME\\Modules\\MyModule\\MyModule.psd1`. The Path parameter is required." } ], "description": "Creates a new module manifest.", diff --git a/command-signatures/json/autogenerated/powershell/new-netipsecauthproposal.json b/command-signatures/json/autogenerated/powershell/new-netipsecauthproposal.json new file mode 100644 index 00000000..f215cc7c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-netipsecauthproposal.json @@ -0,0 +1,381 @@ +{ + "name": "New-NetIPsecAuthProposal", + "options": [ + { + "name": "-AccountMapping", + "description": "Specifies the enabled state for the IPsec certificate-to-account mapping. In certificate-to-account mapping, the Internet Key Exchange (IKE) and AuthIP protocols associate, or map, a user or computer certificate to a user or computer account in an Active Directory (AD) domain or forest, and then retrieves an access token, which includes the list of user security groups. This process ensures that the certificate offered by the IPsec peer corresponds to an active user or computer account in the domain, and that the certificate is one that should be used by that user or computer." + }, + { + "name": "-Anonymous", + "isRequired": true, + "description": "Specifies anonymous authentication. Anonymous authentication means no authentication is performed. This method does not require identity to authenticate. It is equal to no authentication. This provides end-to-end security between hosts, but does not provide any authentication or authorization for which users and computers can connect. This method can be used for both phase 1 and phase 2 authentication." + }, + { + "name": "-Authority", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies, for certificate authentication, the strong name, or X.509 string, of the Certification Authority (CA) that has issued the client certificates. This parameter is used for certificate authentication." + }, + { + "name": "-AuthorityType", + "args": [ + { + "name": "CertificateAuthorityType", + "suggestions": [ + { + "name": "Intermediate" + }, + { + "name": "Invalid" + }, + { + "name": "Root" + } + ] + } + ], + "description": "Specifies that certificates issued by intermediate CAs should be accepted. This parameter is used for certificate authentication. The acceptable values for this parameter are:: Root or Intermediate. The default value is Root. This parameter is supported in Windows Server® 2012." + }, + { + "name": "-Cert", + "isRequired": true, + "description": "Specifies that certificate authentication is used. The *Authority* and *AuthorityType* parameters specify the certification authentication methods." + }, + { + "name": "-ExcludeCAName", + "description": "Specifies that CA names are excluded. This can only be specified for phase 1 authentications." + }, + { + "name": [ + "-ExtendedKeyUsage", + "-EKUs" + ], + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies list of object identifiers (OIDs) that would be used on the extended key usage (EKU) field of a certificate. When a CA issues a certificate, then the EKU specifies the intended purposes of the certificate. For instance, there are specific OIDs for client-server communications as well as secure email and code signing. An IPsec certificate can be selected or validated by EKU OID. There is a limit of `100` EKUs. This parameter is supported in Windows Server 2012." + }, + { + "name": "-FollowRenewal", + "description": "Specifies that certificate signing is automatically renewed. When the certificate is auto-renewed, the IPsec policy will not need to be updated. This parameter only works for authentication methods that define a thumb print with the *Thumbprint* parameter. This parameter only works, and is appropriate, for certificate selection methods. The default value is False. This parameter is supported in Windows Server 2012." + }, + { + "name": "-Health", + "description": "Specifies that the certificate is a health certificate. For phase 2 authentications, if the authentication method is only valid for computer certificates." + }, + { + "name": "-Kerberos", + "isRequired": true, + "description": "Specifies that Kerberos is used. This method authenticates the identity of user or computer accounts by using [Kerberos Protocol Extensions](https://msdn.microsoft.com/library/cc233855.aspx)." + }, + { + "name": "-Machine", + "isRequired": true, + "description": "Specifies that the computer principal should be authenticated rather than the user." + }, + { + "name": "-Ntlm", + "isRequired": true, + "description": "Specifies that NTLM authentication is used." + }, + { + "name": [ + "-PreSharedKey", + "-PSK" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies that the given pre-shared key is used for authentication. The use of a pre-shared key is strongly discouraged, and is provided for interoperability and for conformance to IPsec standards. The pre-shared key is stored in plain text. The use of a more secure authentication method is strongly recommended." + }, + { + "name": "-Proxy", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the fully qualified domain name (FQDN) of the Kerberos proxy to use when authenticating from a remote network. This parameter is supported in Windows Server 2012." + }, + { + "name": "-SelectionCriteria", + "description": "Specifies that the current certificate authentication proposal should be used to select the certificate as offering to remote peers. When using certificate criteria, exactly one proposal for selection and exactly one proposal for validation are needed. A single proposal can be used for both. If this parameter or the *ValidationCriteria* parameter is not specified, then the proposal is used for both. This parameter is supported in Windows Server 2012. The default value is False. If both this parameter and the *ValidationCriteria* parameter are set to False, then the configuration is not valid and both flags in a new phase 1 authentication set or phase 2 authentication are set to True." + }, + { + "name": "-Signing", + "args": [ + { + "name": "CertificateSigningAlgorithm", + "suggestions": [ + { + "name": "ECDSA256" + }, + { + "name": "ECDSA384" + }, + { + "name": "Invalid" + }, + { + "name": "RSA" + } + ] + } + ], + "description": "Specifies the certificate signing algorithm to accept. The acceptable values for this parameter are: RSA, ECDSA256, or ECDSA384. The default value is RSA." + }, + { + "name": "-SubjectName", + "args": [ + { + "name": "String" + } + ], + "description": "Determines, if it is not null, how the certificate should be validated. A certification authority (CA) could put any string value into the Subject Name or Alternative Subject Name fields on a certificate, so there are no format requirements for this parameter. However, depending on the value of SubjectNameType, there are some general formats that are usually followed. Examine the certificates issued by the CA to find the exact formatting to use. If the *SubjectNameType* parameter is: - None: The Subject Name field on a certificate must be null. - DomainName: The Subject Name field on a certificate should generally take the format of a FQDN. The Alternative Subject Name field will be examined. - UserPrincipalName: The Subject Name field on a certificate should generally take the format of an service principal name (SPN). The Alternative Subject Name field will be examined. - EmailAddress: An email address, like `username@contoso.com`. The Alternative Subject Name field on a certificate will be examined. - CN, OU, O, DC: The values from an X.509 strong name. These will be parsed from the Subject Name field on a certificate. This parameter is supported in Windows Server 2012." + }, + { + "name": "-SubjectNameType", + "args": [ + { + "name": "CertificateSubjectType", + "suggestions": [ + { + "name": "CN" + }, + { + "name": "DC" + }, + { + "name": "DomainName" + }, + { + "name": "EmailAddress" + }, + { + "name": "None" + }, + { + "name": "O" + }, + { + "name": "OU" + }, + { + "name": "UserPrincipalName" + } + ] + } + ], + "description": "Determines how the SubjectName field should be interpreted. The acceptable values for this parameter are: None, DomainName, UserPrincipalName, EmailAddress, CN, OU, O, or DC. This parameter is supported in Windows Server 2012." + }, + { + "name": "-Thumbprint", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the thumbprint hashing to use for certification criteria. This is primarily intended for interoperability server-to-server authentication. This parameter cannot be combined with the *FollowRenewal* parameter. This parameter is supported in Windows Server 2012." + }, + { + "name": "-User", + "isRequired": true, + "description": "Specifies that the computer should authenticate as the user account, rather than the computer. This parameter is valid with NTLM, Kerberos, Cert, or Proxy." + }, + { + "name": "-ValidationCriteria", + "description": "For use with certificate criteria. Specifies that the current certificate auth proposal should be used to validate the certificate given by the remote peer. When using certificate criteria, exactly one proposal for selection and exactly one proposal for validation are needed. A single proposal can be used for both. If this parameter or the *SelectionCriteria* parameter is not specified, then the proposal is used for both. This parameter is supported in Windows Server 2012. The default value is False. If both this parameter and the *SelectionCriteria* parameter are set to False, then the configuration is not valid and both flags in a new phase 1 authentication set or phase 2 authentication are set to True." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-PreSharedKey", + "description": "Specifies that the given pre-shared key is used for authentication. The use of a pre-shared key is strongly discouraged, and is provided for interoperability and for conformance to IPsec standards. The pre-shared key is stored in plain text. The use of a more secure authentication method is strongly recommended." + } + ], + "description": "Creates a main mode authentication proposal that specifies a suite of authentication protocols to offer in IPsec main mode negotiations with other computers.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-netipsecmainmodecryptoproposal.json b/command-signatures/json/autogenerated/powershell/new-netipsecmainmodecryptoproposal.json new file mode 100644 index 00000000..5d587ecb --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-netipsecmainmodecryptoproposal.json @@ -0,0 +1,290 @@ +{ + "name": "New-NetIPsecMainModeCryptoProposal", + "options": [ + { + "name": "-Encryption", + "args": [ + { + "name": "EncryptionAlgorithm", + "suggestions": [ + { + "name": "AES128" + }, + { + "name": "AES192" + }, + { + "name": "AES256" + }, + { + "name": "AESGCM128" + }, + { + "name": "AESGCM192" + }, + { + "name": "AESGCM256" + }, + { + "name": "DES" + }, + { + "name": "DES3" + }, + { + "name": "None" + } + ] + } + ], + "description": "Specifies the encryption algorithm to use for IPsec main mode security association negotiations. The block size of the encryption and hashing algorithms must be the same. The acceptable values for this parameter are: None, DES, DES3, AES128, AES192, AES256, AESGCM128, AESGCM192, or AESGCM256. None implies Null Encryption per the RFC standard. The default value is AES256. Neither GCM, for encryption, nor GMAC, for hashing, are supported in main mode. These are quick mode only." + }, + { + "name": "-Hash", + "args": [ + { + "name": "HashAlgorithm", + "suggestions": [ + { + "name": "AESGMAC128" + }, + { + "name": "AESGMAC192" + }, + { + "name": "AESGMAC256" + }, + { + "name": "MD5" + }, + { + "name": "None" + }, + { + "name": "SHA1" + }, + { + "name": "SHA256" + }, + { + "name": "SHA384" + } + ] + } + ], + "description": "Specifies the hashing function to use for IPsec main mode security association negotiations. The block size of the encryption and hashing algorithms should be the same. The acceptable values for this parameter are: None, MD5, SHA1, SHA256, SHA384, AESGMAC128, AESGMAC192, or AESGMAC256. The default value is SHA384." + }, + { + "name": "-KeyExchange", + "args": [ + { + "name": "DiffieHellmanGroup", + "suggestions": [ + { + "name": "DH1" + }, + { + "name": "DH14" + }, + { + "name": "DH19" + }, + { + "name": "DH2" + }, + { + "name": "DH20" + }, + { + "name": "DH24" + }, + { + "name": "None" + }, + { + "name": "SameAsMainMode" + } + ] + } + ], + "description": "Specifies the Diffie-Hellman group to use for IPsec main mode security association negotiations. The acceptable values for this parameter are: None, DH1, DH2, DH14, DH19, DH20, or DH24. The default value is None. SameAsMainMode is only valid for proposals added to quick mode cryptographic sets with PerfectForwardSecrecyGroup (PFS) specified using SameAsMainMode." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Creates a main mode cryptographic proposal that specifies a suite of cryptographic protocols to offer in IPsec main mode negotiations with other computers.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-netipsecquickmodecryptoproposal.json b/command-signatures/json/autogenerated/powershell/new-netipsecquickmodecryptoproposal.json new file mode 100644 index 00000000..0e4ae1f2 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-netipsecquickmodecryptoproposal.json @@ -0,0 +1,328 @@ +{ + "name": "New-NetIPsecQuickModeCryptoProposal", + "options": [ + { + "name": "-AHHash", + "args": [ + { + "name": "HashAlgorithm", + "suggestions": [ + { + "name": "AESGMAC128" + }, + { + "name": "AESGMAC192" + }, + { + "name": "AESGMAC256" + }, + { + "name": "MD5" + }, + { + "name": "None" + }, + { + "name": "SHA1" + }, + { + "name": "SHA256" + }, + { + "name": "SHA384" + } + ] + } + ], + "description": "Specifies the proposed hash algorithm for data integrity and authentication. The acceptable values for this parameter are: None, MD5, SHA1, SHA256, AESGMAC128. AESGMAC192, or AESGMAC256. The default value is None." + }, + { + "name": "-Encapsulation", + "args": [ + { + "name": "IPsecEncapsulation", + "suggestions": [ + { + "name": "AH" + }, + { + "name": "ESP" + }, + { + "name": "None" + } + ] + } + ], + "description": "Specifies the IPsec protocol method. The acceptable values for this parameter are: None, AH, AH,ESP, or ESP. AH (authentication header) and ESP (encapsulating security payload) can both be specified or None can be specified." + }, + { + "name": "-Encryption", + "args": [ + { + "name": "EncryptionAlgorithm", + "suggestions": [ + { + "name": "AES128" + }, + { + "name": "AES192" + }, + { + "name": "AES256" + }, + { + "name": "AESGCM128" + }, + { + "name": "AESGCM192" + }, + { + "name": "AESGCM256" + }, + { + "name": "DES" + }, + { + "name": "DES3" + }, + { + "name": "None" + } + ] + } + ], + "description": "Specifies the value for a main or quick mode cryptographic proposal. The acceptable values for this parameter are: None, DES, DES3, AES128, AES192, AES256, AESGCM128, AESGCM192, or AESGCM256. GCM encryption is not supported in phase 1 authentication for nextref_server_7 and Windows Server 2012. AESGCM128, AESGCM192, and AESGCM256 are not supported for IPsec main mode security association negotiations." + }, + { + "name": "-ESPHash", + "args": [ + { + "name": "HashAlgorithm", + "suggestions": [ + { + "name": "AESGMAC128" + }, + { + "name": "AESGMAC192" + }, + { + "name": "AESGMAC256" + }, + { + "name": "MD5" + }, + { + "name": "None" + }, + { + "name": "SHA1" + }, + { + "name": "SHA256" + }, + { + "name": "SHA384" + } + ] + } + ], + "description": "Specifies the proposed hashing algorithm for data confidentiality and authentication. The acceptable values for this parameter are: None, MD5, SHA1, SHA256, AESGMAC128. AESGMAC192, or AESGMAC256. If the *Encapsulation* parameter is specified as AH is used, then the acceptable values for this parameter are: AESGMAC128, AESGMAC192, AESGMAC256, MD5, SHA1, or SHA256. If the *Encapsulation* parameter is specified as ESP or AH,ESP, then the acceptable values for this parameter are: AESGMAC128, AESGMAC192, AESGMAC256, MD5, SHA1, or SHA256. The default value is None." + }, + { + "name": "-MaxKiloBytes", + "args": [ + { + "name": "UInt64" + } + ], + "description": "Specifies the maximum lifetime, in kilobytes, that the IKE message sender proposes for a security association to be considered valid after it has been created. The acceptable values for this parameter are: 20480 through 2147483647." + }, + { + "name": "-MaxMinutes", + "args": [ + { + "name": "UInt64" + } + ], + "description": "Specifies the number of minutes established for a quick mode security association before it expires and must be renegotiated. The acceptable values for this parameter are: 5 to 2879." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Creates a quick mode cryptographic proposal that specifies a suite of cryptographic protocols to offer in IPsec quick mode negotiations with other computers.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-object.json b/command-signatures/json/autogenerated/powershell/new-object.json index 87529d6e..56681c89 100644 --- a/command-signatures/json/autogenerated/powershell/new-object.json +++ b/command-signatures/json/autogenerated/powershell/new-object.json @@ -11,7 +11,7 @@ "name": "System.Object[]" } ], - "description": "Specifies an array of arguments to pass to the constructor of the .NET Framework class. If the constructor takes a single parameter that is an array, you must wrap that parameter inside another array. For example:\n" + "description": "Specifies an array of arguments to pass to the constructor of the .NET Framework class. If the constructor takes a single parameter that is an array, you must wrap that parameter inside another array. For example:" }, { "name": "-ComObject", @@ -30,7 +30,7 @@ "name": "System.Collections.IDictionary" } ], - "description": "Sets property values and invokes methods of the new object.\n" + "description": "Sets property values and invokes methods of the new object." }, { "name": "-Strict", @@ -223,7 +223,7 @@ }, { "name": "-ArgumentList", - "description": "Specifies an array of arguments to pass to the constructor of the .NET Framework class. If the constructor takes a single parameter that is an array, you must wrap that parameter inside another array. For example:\n" + "description": "Specifies an array of arguments to pass to the constructor of the .NET Framework class. If the constructor takes a single parameter that is an array, you must wrap that parameter inside another array. For example:" } ], "description": "Creates an instance of a Microsoft .NET Framework or COM object.", diff --git a/command-signatures/json/autogenerated/powershell/new-pmemdedicatedmemory.json b/command-signatures/json/autogenerated/powershell/new-pmemdedicatedmemory.json new file mode 100644 index 00000000..8e76c2b7 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-pmemdedicatedmemory.json @@ -0,0 +1,207 @@ +{ + "name": "New-PmemDedicatedMemory", + "options": [ + { + "name": "-FriendlyName", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-RegionId", + "args": [ + { + "name": "uint32[]" + } + ], + "isRequired": true + }, + { + "name": "-SizeInBytes", + "args": [ + { + "name": "uint64[]" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "New-PmemDedicatedMemory -RegionId [-FriendlyName ] [-SizeInBytes ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-pmemdisk.json b/command-signatures/json/autogenerated/powershell/new-pmemdisk.json new file mode 100644 index 00000000..fcf5c652 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-pmemdisk.json @@ -0,0 +1,228 @@ +{ + "name": "New-PmemDisk", + "options": [ + { + "name": "-AtomicityType", + "args": [ + { + "name": "NAMESPACE_ATOMICITY_TYPE[]", + "suggestions": [ + { + "name": "None" + }, + { + "name": "BlockTranslationTable" + } + ] + } + ] + }, + { + "name": "-DiskSizeInBytes", + "args": [ + { + "name": "uint64[]" + } + ], + "isRequired": true + }, + { + "name": "-FriendlyName", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-RegionId", + "args": [ + { + "name": "uint32[]" + } + ], + "isRequired": true + }, + { + "name": "-Simulated", + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "New-PmemDisk -RegionId [-FriendlyName ] [-DiskSizeInBytes ] [-AtomicityType ] [] New-PmemDisk -DiskSizeInBytes -Simulated [-AtomicityType ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-psdrive.json b/command-signatures/json/autogenerated/powershell/new-psdrive.json index e83ba62f..a735a6c5 100644 --- a/command-signatures/json/autogenerated/powershell/new-psdrive.json +++ b/command-signatures/json/autogenerated/powershell/new-psdrive.json @@ -1,15 +1,21 @@ { "name": "New-PSDrive", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to do this action. The default is the current user.\n" + "description": "Specifies a user account that has permission to do this action. The default is the current user." }, { "name": "-Description", @@ -18,7 +24,7 @@ "name": "System.String" } ], - "description": "Specifies a brief text description of the drive. Type any string.\n" + "description": "Specifies a brief text description of the drive. Type any string." }, { "name": "-Name", @@ -32,7 +38,7 @@ }, { "name": "-Persist", - "description": "Indicates that this cmdlet creates a Windows mapped network drive. The Persist parameter is only available on Windows.\n" + "description": "Indicates that this cmdlet creates a Windows mapped network drive. The Persist parameter is only available on Windows." }, { "name": "-PSProvider", @@ -42,7 +48,7 @@ } ], "isRequired": true, - "description": "Specifies the PowerShell provider that supports drives of this kind.\n" + "description": "Specifies the PowerShell provider that supports drives of this kind." }, { "name": "-Root", @@ -52,24 +58,16 @@ } ], "isRequired": true, - "description": "Specifies the data store location to which a PowerShell drive is mapped.\n" + "description": "Specifies the data store location to which a PowerShell drive is mapped." }, { "name": "-Scope", "args": [ { - "name": "System.String", - "default": "Local" + "name": "System.String" } ], - "description": "Specifies a scope for the drive. The acceptable values for this parameter are: Global , Local , and Script , or a number relative to the current scope. Scopes number 0 through the number of scopes. The current scope number is 0 and its parent is 1. For more information, see about_Scopes (../Microsoft.PowerShell.Core/About/about_Scopes.md)." - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies a scope for the drive. The acceptable values for this parameter are: Global, Local, and Script, or a number relative to the current scope. Scopes number 0 through the number of scopes. The current scope number is 0 and its parent is 1. For more information, see [about_Scopes](../Microsoft.PowerShell.Core/About/about_Scopes.md)." }, { "name": [ @@ -256,11 +254,11 @@ }, { "name": "-PSProvider", - "description": "Specifies the PowerShell provider that supports drives of this kind.\n" + "description": "Specifies the PowerShell provider that supports drives of this kind." }, { "name": "-Root", - "description": "Specifies the data store location to which a PowerShell drive is mapped.\n" + "description": "Specifies the data store location to which a PowerShell drive is mapped." } ], "description": "Creates temporary and persistent drives that are associated with a location in an item data store.", diff --git a/command-signatures/json/autogenerated/powershell/new-psrolecapabilityfile.json b/command-signatures/json/autogenerated/powershell/new-psrolecapabilityfile.json index 214b27b0..9a02661c 100644 --- a/command-signatures/json/autogenerated/powershell/new-psrolecapabilityfile.json +++ b/command-signatures/json/autogenerated/powershell/new-psrolecapabilityfile.json @@ -8,7 +8,7 @@ "name": "System.Collections.IDictionary[]" } ], - "description": "Adds the specified aliases to sessions that use the role capability file. Enter a hash table with the following keys:\n" + "description": "Adds the specified aliases to sessions that use the role capability file. Enter a hash table with the following keys:" }, { "name": "-AssembliesToLoad", @@ -62,7 +62,7 @@ "name": "System.Collections.IDictionary" } ], - "description": "Specifies the environment variables for sessions that expose this role capability file. Enter a hash table in which the keys are the environment variable names and the values are the environment variable values.\n" + "description": "Specifies the environment variables for sessions that expose this role capability file. Enter a hash table in which the keys are the environment variable names and the values are the environment variable values." }, { "name": "-FormatsToProcess", @@ -80,7 +80,7 @@ "name": "System.Collections.IDictionary[]" } ], - "description": "Adds the specified functions to sessions that expose the role capability. Enter a hash table with the following keys:\n" + "description": "Adds the specified functions to sessions that expose the role capability. Enter a hash table with the following keys:" }, { "name": "-Guid", @@ -98,7 +98,7 @@ "name": "System.Object[]" } ], - "description": "Specifies the modules that are automatically imported into sessions that use the role capability file. By default, all the commands in listed modules are visible. When used with VisibleCmdlets or VisibleFunctions , the commands visible from the specified modules can be restricted.\n" + "description": "Specifies the modules that are automatically imported into sessions that use the role capability file. By default, all the commands in listed modules are visible. When used with VisibleCmdlets or VisibleFunctions, the commands visible from the specified modules can be restricted." }, { "name": "-Path", @@ -135,7 +135,7 @@ "name": "System.Object" } ], - "description": "Specifies variables to add to sessions that use the role capability file. Enter a hash table with the following keys:\n" + "description": "Specifies variables to add to sessions that use the role capability file. Enter a hash table with the following keys:" }, { "name": "-VisibleAliases", @@ -144,7 +144,7 @@ "name": "System.String[]" } ], - "description": "Limits the aliases in the session to those aliases specified in the value of this parameter, plus any aliases that you define in the AliasDefinition parameter. Wildcard characters are supported. By default, all aliases that are defined by the PowerShell engine and all aliases that modules export are visible in the session.\n" + "description": "Limits the aliases in the session to those aliases specified in the value of this parameter, plus any aliases that you define in the AliasDefinition parameter. Wildcard characters are supported. By default, all aliases that are defined by the PowerShell engine and all aliases that modules export are visible in the session." }, { "name": "-VisibleCmdlets", @@ -153,7 +153,7 @@ "name": "System.Object[]" } ], - "description": "Limits the cmdlets in the session to those specified in the value of this parameter. Wildcard characters and Module Qualified Names are supported.\n" + "description": "Limits the cmdlets in the session to those specified in the value of this parameter. Wildcard characters and Module Qualified Names are supported." }, { "name": "-VisibleExternalCommands", @@ -162,7 +162,7 @@ "name": "System.String[]" } ], - "description": "Limits the external binaries, scripts and commands that can be executed in the session to those specified in the value of this parameter.\n" + "description": "Limits the external binaries, scripts and commands that can be executed in the session to those specified in the value of this parameter." }, { "name": "-VisibleFunctions", @@ -171,7 +171,7 @@ "name": "System.Object[]" } ], - "description": "Limits the functions in the session to those specified in the value of this parameter, plus any functions that you define in the FunctionDefinitions parameter. Wildcard characters are supported.\n" + "description": "Limits the functions in the session to those specified in the value of this parameter, plus any functions that you define in the FunctionDefinitions parameter. Wildcard characters are supported." }, { "name": "-VisibleProviders", @@ -180,7 +180,7 @@ "name": "System.String[]" } ], - "description": "Limits the PowerShell providers in the session to those specified in the value of this parameter. Wildcard characters are supported.\n" + "description": "Limits the PowerShell providers in the session to those specified in the value of this parameter. Wildcard characters are supported." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/new-psscriptfileinfo.json b/command-signatures/json/autogenerated/powershell/new-psscriptfileinfo.json index 69aa916c..aecf2d1c 100644 --- a/command-signatures/json/autogenerated/powershell/new-psscriptfileinfo.json +++ b/command-signatures/json/autogenerated/powershell/new-psscriptfileinfo.json @@ -64,8 +64,7 @@ "name": "-Guid", "args": [ { - "name": "System.Guid", - "default": "Randomly generated" + "name": "System.Guid" } ], "description": "The unique identifier for the script in GUID format. If you don't provide a GUID, the cmdlet creates a new one automatically." @@ -132,7 +131,7 @@ "name": "System.Collections.Hashtable[]" } ], - "description": "The parameter takes an array of module specification hashtables. A module specification is a hashtable that has the following keys.\n" + "description": "The parameter takes an array of module specification hashtables. A module specification is a hashtable that has the following keys." }, { "name": "-RequiredScripts", @@ -153,7 +152,7 @@ "name": "System.String[]" } ], - "description": "The tags associated with the script. Tag values are strings that shouldn't contain spaces. For more information, see Tag details (/powershell/scripting/gallery/concepts/package-manifest-affecting-ui#tag-details)." + "description": "The tags associated with the script. Tag values are strings that shouldn't contain spaces. For more information, see [Tag details](/powershell/scripting/gallery/concepts/package-manifest-affecting-ui#tag-details)." }, { "name": "-Version", diff --git a/command-signatures/json/autogenerated/powershell/new-pssession.json b/command-signatures/json/autogenerated/powershell/new-pssession.json index 74b195ff..85dd86cc 100644 --- a/command-signatures/json/autogenerated/powershell/new-pssession.json +++ b/command-signatures/json/autogenerated/powershell/new-pssession.json @@ -3,7 +3,7 @@ "options": [ { "name": "-AllowRedirection", - "description": "Indicates that this cmdlet allows redirection of this connection to an alternate Uniform Resource Identifier (URI).\n" + "description": "Indicates that this cmdlet allows redirection of this connection to an alternate Uniform Resource Identifier (URI)." }, { "name": "-ApplicationName", @@ -12,7 +12,7 @@ "name": "System.String" } ], - "description": "Specifies the application name segment of the connection URI. Use this parameter to specify the application name when you are not using the ConnectionURI parameter in the command.\n" + "description": "Specifies the application name segment of the connection URI. Use this parameter to specify the application name when you are not using the ConnectionURI parameter in the command." }, { "name": "-Authentication", @@ -21,30 +21,30 @@ "name": "System.Management.Automation.Runspaces.AuthenticationMechanism", "suggestions": [ { - "name": "Default" + "name": "Basic" }, { - "name": "Basic" + "name": "Credssp" }, { - "name": "Negotiate" + "name": "Default" }, { - "name": "NegotiateWithImplicitCredential" + "name": "Digest" }, { - "name": "Credssp" + "name": "Kerberos" }, { - "name": "Digest" + "name": "Negotiate" }, { - "name": "Kerberos" + "name": "NegotiateWithImplicitCredential" } ] } ], - "description": "Specifies the mechanism that is used to authenticate the user's credentials. The acceptable values for this parameter are:\n" + "description": "Specifies the mechanism that is used to authenticate the user's credentials. The acceptable values for this parameter are:" }, { "name": "-CertificateThumbprint", @@ -53,7 +53,7 @@ "name": "System.String" } ], - "description": "Specifies the digital public key certificate (X509) of a user account that has permission to perform this action. Enter the certificate thumbprint of the certificate.\n" + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to perform this action. Enter the certificate thumbprint of the certificate." }, { "name": [ @@ -65,7 +65,7 @@ "name": "System.String[]" } ], - "description": "Specifies an array of names of computers. This cmdlet creates a persistent connection ( PSSession ) to the specified computer. If you enter multiple computer names, `New-PSSession` creates multiple PSSession objects, one for each computer. The default is the local computer.\n" + "description": "Specifies an array of names of computers. This cmdlet creates a persistent connection (PSSession) to the specified computer. If you enter multiple computer names, `New-PSSession` creates multiple PSSession objects, one for each computer. The default is the local computer." }, { "name": "-ConfigurationName", @@ -74,17 +74,16 @@ "name": "System.String" } ], - "description": "Specifies the session configuration that is used for the new PSSession .\n" + "description": "Specifies the session configuration that is used for the new PSSession." }, { "name": "-ConnectingTimeout", "args": [ { - "name": "System.Int32", - "default": "unlimited" + "name": "System.Int32" } ], - "description": "Specifies the amount of time in milliseconds allowed for the initial SSH connection to complete. If the connection doesn't complete within the specified time, an error is returned.\n" + "description": "Specifies the amount of time in milliseconds allowed for the initial SSH connection to complete. If the connection doesn't complete within the specified time, an error is returned." }, { "name": [ @@ -98,7 +97,7 @@ } ], "isRequired": true, - "description": "Specifies a URI that defines the connection endpoint for the session. The URI must be fully qualified. The format of this string is as follows:\n" + "description": "Specifies a URI that defines the connection endpoint for the session. The URI must be fully qualified. The format of this string is as follows:" }, { "name": "-ContainerId", @@ -108,21 +107,21 @@ } ], "isRequired": true, - "description": "Specifies an array of IDs of containers. This cmdlet starts an interactive session with each of the specified containers. Use the `docker ps` command to get a list of container IDs. For more information, see the help for the docker ps (https://docs.docker.com/engine/reference/commandline/ps/)command." + "description": "Specifies an array of IDs of containers. This cmdlet starts an interactive session with each of the specified containers. Use the `docker ps` command to get a list of container IDs. For more information, see the help for the [docker ps](https://docs.docker.com/engine/reference/commandline/ps/) command." }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to do this action. The default is the current user.\n" + "isRequired": true, + "description": "Specifies a user account that has permission to do this action. The default is the current user." }, { "name": "-EnableNetworkAccess", - "description": "Indicates that this cmdlet adds an interactive security token to loopback sessions. The interactive token lets you run commands in the loopback session that get data from other computers. For example, you can run a command in the session that copies XML files from a remote computer to the local computer.\n" + "description": "Indicates that this cmdlet adds an interactive security token to loopback sessions. The interactive token lets you run commands in the loopback session that get data from other computers. For example, you can run a command in the session that copies XML files from a remote computer to the local computer." }, { "name": "-HostName", @@ -132,7 +131,7 @@ } ], "isRequired": true, - "description": "Specifies an array of computer names for a Secure Shell (SSH) based connection. This is similar to the ComputerName parameter except that the connection to the remote computer is made using SSH rather than Windows WinRM.\n" + "description": "Specifies an array of computer names for a Secure Shell (SSH) based connection. This is similar to the ComputerName parameter except that the connection to the remote computer is made using SSH rather than Windows WinRM." }, { "name": [ @@ -144,7 +143,7 @@ "name": "System.String" } ], - "description": "Specifies a key file path used by Secure Shell (SSH) to authenticate a user on a remote computer.\n" + "description": "Specifies a key file path used by Secure Shell (SSH) to authenticate a user on a remote computer." }, { "name": "-Name", @@ -153,7 +152,7 @@ "name": "System.String[]" } ], - "description": "Specifies a friendly name for the PSSession .\n" + "description": "Specifies a friendly name for the PSSession." }, { "name": "-Options", @@ -162,7 +161,7 @@ "name": "System.Collections.Hashtable" } ], - "description": "Specifies a hashtable of SSH options used when connecting to a remote SSH-based session. The possible options are any values supported by the Unix-based version of the ssh (https://man.openbsd.org/ssh#o)command.\n" + "description": "Specifies a hashtable of SSH options used when connecting to a remote SSH-based session. The possible options are any values supported by the Unix-based version of the [ssh](https://man.openbsd.org/ssh#o) command." }, { "name": "-Port", @@ -171,7 +170,7 @@ "name": "System.Int32" } ], - "description": "Specifies the network port on the remote computer that is used for this connection. To connect to a remote computer, the remote computer must be listening on the port that the connection uses. The default ports are `5985`, which is the WinRM port for HTTP, and `5986`, which is the WinRM port for HTTPS.\n" + "description": "Specifies the network port on the remote computer that is used for this connection. To connect to a remote computer, the remote computer must be listening on the port that the connection uses. The default ports are `5985`, which is the WinRM port for HTTP, and `5986`, which is the WinRM port for HTTPS." }, { "name": "-RunAsAdministrator", @@ -184,7 +183,7 @@ "name": "System.Management.Automation.Runspaces.PSSession[]" } ], - "description": "Specifies an array of PSSession objects that this cmdlet uses as a model for the new PSSession . This parameter creates new PSSession objects that have the same properties as the specified PSSession objects.\n" + "description": "Specifies an array of PSSession objects that this cmdlet uses as a model for the new PSSession. This parameter creates new PSSession objects that have the same properties as the specified PSSession objects." }, { "name": "-SessionOption", @@ -193,7 +192,7 @@ "name": "System.Management.Automation.Remoting.PSSessionOption" } ], - "description": "Specifies advanced options for the session. Enter a SessionOption object, such as one that you create by using the `New-PSSessionOption` cmdlet, or a hash table in which the keys are session option names and the values are session option values.\n" + "description": "Specifies advanced options for the session. Enter a SessionOption object, such as one that you create by using the `New-PSSessionOption` cmdlet, or a hash table in which the keys are session option names and the values are session option values." }, { "name": "-SSHConnection", @@ -203,21 +202,20 @@ } ], "isRequired": true, - "description": "This parameter takes an array of hashtables where each hashtable contains one or more connection parameters needed to establish a Secure Shell (SSH) connection ( HostName , Port , UserName , KeyFilePath ).\n" + "description": "This parameter takes an array of hashtables where each hashtable contains one or more connection parameters needed to establish a Secure Shell (SSH) connection (HostName, Port, UserName, KeyFilePath)." }, { "name": "-SSHTransport", - "description": "Indicates that the remote connection is established using Secure Shell (SSH).\n" + "description": "Indicates that the remote connection is established using Secure Shell (SSH)." }, { "name": "-Subsystem", "args": [ { - "name": "System.String", - "default": "powershell" + "name": "System.String" } ], - "description": "Specifies the SSH subsystem used for the new PSSession .\n" + "description": "Specifies the SSH subsystem used for the new PSSession." }, { "name": "-ThrottleLimit", @@ -226,7 +224,7 @@ "name": "System.Int32" } ], - "description": "Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this parameter or enter a value of `0` (zero), the default value, `32`, is used.\n" + "description": "Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this parameter or enter a value of `0` (zero), the default value, `32`, is used." }, { "name": "-UserName", @@ -235,11 +233,11 @@ "name": "System.String" } ], - "description": "Specifies the username for the account used to create a session on the remote computer. The user authentication method depends on how Secure Shell (SSH) is configured on the remote computer.\n" + "description": "Specifies the user name for the account used to create a session on the remote computer. If the UserName parameter isn't specified then the current logged on username is used. User authentication method depends on how Secure Shell (SSH) is configured on the remote computer." }, { "name": "-UseSSL", - "description": "Indicates that this cmdlet uses the SSL protocol to establish a connection to the remote computer. By default, SSL is not used.\n" + "description": "Indicates that this cmdlet uses the SSL protocol to establish a connection to the remote computer. By default, SSL is not used." }, { "name": "-UseWindowsPowerShell", @@ -257,7 +255,7 @@ } ], "isRequired": true, - "description": "Specifies an array of virtual machine IDs. This cmdlet starts a PowerShell Direct interactive session with each of the specified virtual machines. For more information, see Virtual Machine automation and management using PowerShell (/virtualization/hyper-v-on-windows/user-guide/powershell-direct).\n" + "description": "Specifies an array of virtual machine IDs. This cmdlet starts a PowerShell Direct interactive session with each of the specified virtual machines. For more information, see [Virtual Machine automation and management using PowerShell](/virtualization/hyper-v-on-windows/user-guide/powershell-direct)." }, { "name": "-VMName", @@ -267,7 +265,7 @@ } ], "isRequired": true, - "description": "Specifies an array of names of virtual machines. This cmdlet starts a PowerShell Direct interactive session with each of the specified virtual machines. For more information, see Virtual Machine automation and management using PowerShell (/virtualization/hyper-v-on-windows/user-guide/powershell-direct).\n" + "description": "Specifies an array of names of virtual machines. This cmdlet starts a PowerShell Direct interactive session with each of the specified virtual machines. For more information, see [Virtual Machine automation and management using PowerShell](/virtualization/hyper-v-on-windows/user-guide/powershell-direct)." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/new-pssessionconfigurationfile.json b/command-signatures/json/autogenerated/powershell/new-pssessionconfigurationfile.json index b4c1520e..24d09b5b 100644 --- a/command-signatures/json/autogenerated/powershell/new-pssessionconfigurationfile.json +++ b/command-signatures/json/autogenerated/powershell/new-pssessionconfigurationfile.json @@ -8,7 +8,7 @@ "name": "System.Collections.IDictionary[]" } ], - "description": "Adds the specified aliases to sessions that use the session configuration. Enter a hash table with the following keys:\n" + "description": "Adds the specified aliases to sessions that use the session configuration. Enter a hash table with the following keys:" }, { "name": "-AssembliesToLoad", @@ -32,11 +32,10 @@ "name": "-CompanyName", "args": [ { - "name": "System.String", - "default": "Unknown" + "name": "System.String" } ], - "description": "Specifies the company that created the session configuration or the configuration file. The default value is Unknown . The value of this parameter is visible in the session configuration file, but it is not a property of the session configuration object." + "description": "Specifies the company that created the session configuration or the configuration file. The default value is Unknown. The value of this parameter is visible in the session configuration file, but it is not a property of the session configuration object." }, { "name": "-Copyright", @@ -45,7 +44,7 @@ "name": "System.String" } ], - "description": "Specifies a copyright the session configuration file. The value of this parameter is visible in the session configuration file, but it is not a property of the session configuration object.\n" + "description": "Specifies a copyright the session configuration file. The value of this parameter is visible in the session configuration file, but it is not a property of the session configuration object." }, { "name": "-Description", @@ -63,7 +62,7 @@ "name": "System.Collections.IDictionary" } ], - "description": "Adds environment variables to the session. Enter a hash table in which the keys are the environment variable names and the values are the environment variable values.\n" + "description": "Adds environment variables to the session. Enter a hash table in which the keys are the environment variable names and the values are the environment variable values." }, { "name": "-ExecutionPolicy", @@ -72,30 +71,30 @@ "name": "Microsoft.PowerShell.ExecutionPolicy", "suggestions": [ { - "name": "Unrestricted" + "name": "AllSigned" }, { - "name": "RemoteSigned" + "name": "Bypass" }, { - "name": "AllSigned" + "name": "Default" }, { - "name": "Restricted" + "name": "RemoteSigned" }, { - "name": "Default" + "name": "Restricted" }, { - "name": "Bypass" + "name": "Undefined" }, { - "name": "Undefined" + "name": "Unrestricted" } ] } ], - "description": "Specifies the execution policy of sessions that use the session configuration. If you omit this parameter, the value of the ExecutionPolicy key in the session configuration file is Restricted . For information about execution policies in PowerShell, see about_Execution_Policies (about/about_Execution_Policies.md)." + "description": "Specifies the execution policy of sessions that use the session configuration. If you omit this parameter, the value of the ExecutionPolicy key in the session configuration file is Restricted. For information about execution policies in PowerShell, see [about_Execution_Policies](About/about_Execution_Policies.md)." }, { "name": "-FormatsToProcess", @@ -104,7 +103,7 @@ "name": "System.String[]" } ], - "description": "Specifies the formatting files (.ps1xml) that run in sessions that use the session configuration. The value of this parameter must be a full or absolute path of the formatting files." + "description": "Specifies the formatting files (`.ps1xml`) that run in sessions that use the session configuration. The value of this parameter must be a full or absolute path of the formatting files." }, { "name": "-Full", @@ -117,7 +116,7 @@ "name": "System.Collections.IDictionary[]" } ], - "description": "Adds the specified functions to sessions that use the session configuration. Enter a hash table with the following keys:\n" + "description": "Adds the specified functions to sessions that use the session configuration. Enter a hash table with the following keys:" }, { "name": "-GroupManagedServiceAccount", @@ -144,21 +143,21 @@ "name": "System.Management.Automation.PSLanguageMode", "suggestions": [ { - "name": "FullLanguage" + "name": "ConstrainedLanguage" }, { - "name": "RestrictedLanguage" + "name": "FullLanguage" }, { "name": "NoLanguage" }, { - "name": "ConstrainedLanguage" + "name": "RestrictedLanguage" } ] } ], - "description": "Determines which elements of the PowerShell language are permitted in sessions that use this session configuration. You can use this parameter to restrict the commands that particular users can run on the computer.\n" + "description": "Determines which elements of the PowerShell language are permitted in sessions that use this session configuration. You can use this parameter to restrict the commands that particular users can run on the computer." }, { "name": "-ModulesToImport", @@ -167,11 +166,11 @@ "name": "System.Object[]" } ], - "description": "Specifies the modules and snap-ins that are automatically imported into sessions that use the session configuration.\n" + "description": "Specifies the modules and snap-ins that are automatically imported into sessions that use the session configuration." }, { "name": "-MountUserDrive", - "description": "Configures sessions that use this session configuration to expose the `User:` PSDrive. User drives are unique for each connecting user and allow users to copy data to and from PowerShell endpoints even if the File System provider is not exposed. User drive roots are created under `$env:LOCALAPPDATA\\Microsoft\\PowerShell\\DriveRoots`. For each user connecting to the endpoint, a folder is created with the name `$env:USERDOMAIN\\$env:USERNAME`. For computers in workgroups, the value of `$env:USERDOMAIN` is the hostname.\n" + "description": "Configures sessions that use this session configuration to expose the `User:` PSDrive. User drives are unique for each connecting user and allow users to copy data to and from PowerShell endpoints even if the FileSystem provider is not exposed. User drive roots are created under `$Env:LOCALAPPDATA\\Microsoft\\PowerShell\\DriveRoots\\`. For each user connecting to the endpoint, a folder is created with the name `$Env:USERDOMAIN\\$Env:USERNAME`. For computers in workgroups, the value of `$Env:USERDOMAIN` is the hostname." }, { "name": "-Path", @@ -190,7 +189,7 @@ "name": "System.Version" } ], - "description": "Specifies the version of the PowerShell engine in sessions that use the session configuration. The acceptable values for this parameter are: 2.0 and 3.0. If you omit this parameter, the PowerShellVersion key is commented-out and newest version of PowerShell runs in the session.\n" + "description": "Specifies the version of the PowerShell engine in sessions that use the session configuration. The acceptable values for this parameter are: 2.0 and 3.0. If you omit this parameter, the PowerShellVersion key is commented-out and newest version of PowerShell runs in the session." }, { "name": "-RequiredGroups", @@ -199,7 +198,7 @@ "name": "System.Collections.IDictionary" } ], - "description": "Specifies conditional access rules for users connecting to sessions that use this session configuration.\n" + "description": "Specifies conditional access rules for users connecting to sessions that use this session configuration." }, { "name": "-RoleDefinitions", @@ -208,7 +207,7 @@ "name": "System.Collections.IDictionary" } ], - "description": "Specifies the mapping between security groups (or users) and role capabilities. Users will be granted access to all role capabilities which apply to their group membership at the time the session is created.\n" + "description": "Specifies the mapping between security groups (or users) and role capabilities. Users will be granted access to all role capabilities which apply to their group membership at the time the session is created." }, { "name": "-RunAsVirtualAccount", @@ -248,18 +247,18 @@ "name": "System.Management.Automation.Remoting.SessionType", "suggestions": [ { - "name": "Empty" + "name": "Default" }, { - "name": "RestrictedRemoteServer" + "name": "Empty" }, { - "name": "Default" + "name": "RestrictedRemoteServer" } ] } ], - "description": "Specifies the type of session that is created by using the session configuration. The default value is Default. The acceptable values for this parameter are:\n" + "description": "Specifies the type of session that is created by using the session configuration. The default value is Default. The acceptable values for this parameter are:" }, { "name": "-TranscriptDirectory", @@ -286,7 +285,7 @@ "name": "System.Int64" } ], - "description": "Specifies the maximum size for user drives exposed in sessions that use this session configuration. When omitted, the default size of each `User:` drive root is 50MB.\n" + "description": "Specifies the maximum size for user drives exposed in sessions that use this session configuration. When omitted, the default size of each `User:` drive root is 50MB." }, { "name": "-VariableDefinitions", @@ -295,7 +294,7 @@ "name": "System.Object" } ], - "description": "Adds the specified variables to sessions that use the session configuration. Enter a hash table with the following keys:\n" + "description": "Adds the specified variables to sessions that use the session configuration. Enter a hash table with the following keys:" }, { "name": "-VisibleAliases", @@ -304,7 +303,7 @@ "name": "System.String[]" } ], - "description": "Limits the aliases in the session to those specified in the value of this parameter, plus any aliases that you define in the AliasDefinition parameter. Wildcard characters are supported. By default, all aliases that are defined by the PowerShell engine and all aliases that modules export are visible in the session.\n" + "description": "Limits the aliases in the session to those specified in the value of this parameter, plus any aliases that you define in the AliasDefinition parameter. Wildcard characters are supported. By default, all aliases that are defined by the PowerShell engine and all aliases that modules export are visible in the session." }, { "name": "-VisibleCmdlets", @@ -313,7 +312,7 @@ "name": "System.Object[]" } ], - "description": "Limits the cmdlets in the session to those specified in the value of this parameter. Wildcard characters and Module Qualified Names are supported.\n" + "description": "Limits the cmdlets in the session to those specified in the value of this parameter. Wildcard characters and Module Qualified Names are supported." }, { "name": "-VisibleExternalCommands", @@ -322,7 +321,7 @@ "name": "System.String[]" } ], - "description": "Limits the external binaries, scripts, and commands that can be executed in the session to those specified in the value of this parameter. Wildcard characters are supported.\n" + "description": "Limits the external binaries, scripts, and commands that can be executed in the session to those specified in the value of this parameter. Wildcard characters are supported." }, { "name": "-VisibleFunctions", @@ -331,7 +330,7 @@ "name": "System.Object[]" } ], - "description": "Limits the functions in the session to those specified in the value of this parameter, plus any functions that you define in the FunctionDefinition parameter. Wildcard characters are supported.\n" + "description": "Limits the functions in the session to those specified in the value of this parameter, plus any functions that you define in the FunctionDefinition parameter. Wildcard characters are supported." }, { "name": "-VisibleProviders", @@ -340,7 +339,7 @@ "name": "System.String[]" } ], - "description": "Limits the PowerShell providers in the session to those specified in the value of this parameter. Wildcard characters are supported.\n" + "description": "Limits the PowerShell providers in the session to those specified in the value of this parameter. Wildcard characters are supported." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/new-pssessionoption.json b/command-signatures/json/autogenerated/powershell/new-pssessionoption.json index 0141574d..d72cd9b7 100644 --- a/command-signatures/json/autogenerated/powershell/new-pssessionoption.json +++ b/command-signatures/json/autogenerated/powershell/new-pssessionoption.json @@ -8,7 +8,7 @@ "name": "System.Management.Automation.PSPrimitiveDictionary" } ], - "description": "Specifies a PrimitiveDictionary that is sent to the remote session. Commands and scripts in the remote session, including startup scripts in the session configuration, can find this dictionary in the ApplicationArguments property of the `$PSSenderInfo` automatic variable. You can use this parameter to send data to the remote session.\n" + "description": "Specifies a PrimitiveDictionary that's sent to the remote session. Commands and scripts in the remote session, including startup scripts in the session configuration, can find this dictionary in the ApplicationArguments property of the `$PSSenderInfo` automatic variable. You can use this parameter to send data to the remote session." }, { "name": [ @@ -17,11 +17,10 @@ ], "args": [ { - "name": "System.Int32", - "default": "60000" + "name": "System.Int32" } ], - "description": "Determines how long PowerShell waits for a cancel operation (CTRL+C) to finish before ending it. Enter a value in milliseconds.\n" + "description": "Determines how long PowerShell waits for a cancel operation (CTRL+C) to finish before ending it. Enter a value in milliseconds." }, { "name": "-Culture", @@ -30,7 +29,7 @@ "name": "System.Globalization.CultureInfo" } ], - "description": "Specifies the culture to use for the session. Enter a culture name in `-` format (like `ja-JP`), a variable that contains a CultureInfo object, or a command that gets a CultureInfo object.\n" + "description": "Specifies the culture to use for the session. Enter a culture name in `-` format (like `ja-JP`), a variable that contains a CultureInfo object, or a command that gets a CultureInfo object." }, { "name": [ @@ -42,11 +41,11 @@ "name": "System.Int32" } ], - "description": "Determines how long the session stays open if the remote computer does not receive any communication from the local computer. This includes the heartbeat signal. When the interval expires, the session closes.\n" + "description": "Determines how long the session stays open if the remote computer does not receive any communication from the local computer. This includes the heartbeat signal. When the interval expires, the session closes." }, { "name": "-IncludePortInSPN", - "description": "Includes the port number in the Service Principal Name (SPN) used for Kerberos authentication, for example, `HTTP://:5985`. This option allows a client that uses a non-default SPN to authenticate against a remote computer that uses Kerberos authentication.\n" + "description": "Includes the port number in the Service Principal Name (SPN) used for Kerberos authentication, for example, `HTTP://:5985`. This option allows a client that uses a non-default SPN to authenticate against a remote computer that uses Kerberos authentication." }, { "name": "-MaxConnectionRetryCount", @@ -55,7 +54,7 @@ "name": "System.Int32" } ], - "description": "Specifies the number of times that PowerShell attempts to make a connection to a target machine if the current attempt fails due to network issues. The default value is `5`.\n" + "description": "Specifies the number of times that PowerShell attempts to make a connection to a target machine if the current attempt fails due to network issues. The default value is `5`." }, { "name": "-MaximumReceivedDataSizePerCommand", @@ -64,27 +63,25 @@ "name": "System.Int32" } ], - "description": "Specifies the maximum number of bytes that the local computer can receive from the remote computer in a single command. Enter a value in bytes. By default, there is no data size limit.\n" + "description": "Specifies the maximum number of bytes that the local computer can receive from the remote computer in a single command. Enter a value in bytes. By default, there is no data size limit." }, { "name": "-MaximumReceivedObjectSize", "args": [ { - "name": "System.Int32", - "default": "209715200" + "name": "System.Int32" } ], - "description": "Specifies the maximum size of an object that the local computer can receive from the remote computer. This option is designed to protect the resources on the client computer. Enter a value in bytes.\n" + "description": "Specifies the maximum size of an object that the local computer can receive from the remote computer. This option is designed to protect the resources on the client computer. Enter a value in bytes." }, { "name": "-MaximumRedirection", "args": [ { - "name": "System.Int32", - "default": "5" + "name": "System.Int32" } ], - "description": "Determines how many times PowerShell redirects a connection to an alternate Uniform Resource Identifier (URI) before the connection fails. The default value is `5`. A value of `0` (zero) prevents all redirection.\n" + "description": "Determines how many times PowerShell redirects a connection to an alternate Uniform Resource Identifier (URI) before the connection fails. The default value is `5`. A value of `0` (zero) prevents all redirection." }, { "name": "-NoCompression", @@ -105,11 +102,10 @@ ], "args": [ { - "name": "System.Int32", - "default": "180000 (3 minutes)" + "name": "System.Int32" } ], - "description": "Determines how long the client computer waits for the session connection to be established. When the interval expires, the command to establish the connection fails. Enter a value in milliseconds.\n" + "description": "Determines how long the client computer waits for the session connection to be established. When the interval expires, the command to establish the connection fails. Enter a value in milliseconds." }, { "name": [ @@ -118,11 +114,10 @@ ], "args": [ { - "name": "System.Int32", - "default": "180000 (3 minutes)" + "name": "System.Int32" } ], - "description": "Determines the maximum time WinRM waits for positive connection tests from a live connection before initiating a connection time-out. For more information on WinRM, see the Windows Remote Management Documentation (/windows/win32/winrm/portal). OperationTimeout does not impose a time limit on commands or processes running in a remote session and does not affect other remoting protocols like SSH.\n" + "description": "Determines the maximum time WinRM waits for positive connection tests from a live connection before initiating a connection time-out. For more information on WinRM, see the [Windows Remote Management Documentation](/windows/win32/winrm/portal)." }, { "name": "-OutputBufferingMode", @@ -131,18 +126,18 @@ "name": "System.Management.Automation.Runspaces.OutputBufferingMode", "suggestions": [ { - "name": "None" + "name": "Block" }, { "name": "Drop" }, { - "name": "Block" + "name": "None" } ] } ], - "description": "Determines how command output is managed in disconnected sessions when the output buffer becomes full.\n" + "description": "Determines how command output is managed in disconnected sessions when the output buffer becomes full." }, { "name": "-ProxyAccessType", @@ -151,24 +146,24 @@ "name": "System.Management.Automation.Remoting.ProxyAccessType", "suggestions": [ { - "name": "None" + "name": "AutoDetect" }, { "name": "IEConfig" }, { - "name": "WinHttpConfig" + "name": "None" }, { - "name": "AutoDetect" + "name": "NoProxyServer" }, { - "name": "NoProxyServer" + "name": "WinHttpConfig" } ] } ], - "description": "Determines which mechanism is used to resolve the hostname. The acceptable values for this parameter are:\n" + "description": "Determines which mechanism is used to resolve the hostname. The acceptable values for this parameter are:" }, { "name": "-ProxyAuthentication", @@ -177,31 +172,30 @@ "name": "System.Management.Automation.Runspaces.AuthenticationMechanism", "suggestions": [ { - "name": "Default" + "name": "Basic" }, { - "name": "Basic" + "name": "Credssp" }, { - "name": "Negotiate" + "name": "Default" }, { - "name": "NegotiateWithImplicitCredential" + "name": "Digest" }, { - "name": "Credssp" + "name": "Kerberos" }, { - "name": "Digest" + "name": "Negotiate" }, { - "name": "Kerberos" + "name": "NegotiateWithImplicitCredential" } - ], - "default": "Negotiate" + ] } ], - "description": "Specifies the authentication method that is used for proxy resolution. The acceptable values for this parameter are:\n" + "description": "Specifies the authentication method that is used for proxy resolution. The acceptable values for this parameter are:" }, { "name": "-ProxyCredential", @@ -214,11 +208,11 @@ }, { "name": "-SkipCACheck", - "description": "Specifies that when it connects over HTTPS, the client does not validate that the server certificate is signed by a trusted certification authority (CA).\n" + "description": "Specifies that when it connects over HTTPS, the client does not validate that the server certificate is signed by a trusted certification authority (CA)." }, { "name": "-SkipCNCheck", - "description": "Specifies that the certificate common name (CN) of the server does not have to match the hostname of the server. This option is used only in remote operations that use the HTTPS protocol.\n" + "description": "Specifies that the certificate common name (CN) of the server does not have to match the hostname of the server. This option is used only in remote operations that use the HTTPS protocol." }, { "name": "-SkipRevocationCheck", @@ -231,7 +225,7 @@ "name": "System.Globalization.CultureInfo" } ], - "description": "Specifies the UI culture to use for the session.\n" + "description": "Specifies the UI culture to use for the session." }, { "name": "-UseUTF16", diff --git a/command-signatures/json/autogenerated/powershell/new-pstransportoption.json b/command-signatures/json/autogenerated/powershell/new-pstransportoption.json index a29cfd0d..d5fb38d1 100644 --- a/command-signatures/json/autogenerated/powershell/new-pstransportoption.json +++ b/command-signatures/json/autogenerated/powershell/new-pstransportoption.json @@ -8,7 +8,7 @@ "name": "System.Nullable`1[System.Int32]" } ], - "description": "Determines how long each session stays open if the remote computer does not receive any communication from the local computer. This includes the heartbeat signal. When the interval expires, the session closes.\n" + "description": "Determines how long each session stays open if the remote computer does not receive any communication from the local computer. This includes the heartbeat signal. When the interval expires, the session closes." }, { "name": "-MaxConcurrentCommandsPerSession", @@ -17,7 +17,7 @@ "name": "System.Nullable`1[System.Int32]" } ], - "description": "Limits the number of commands that can run at the same time in each session to the specified value. The default value is 1000.\n" + "description": "Limits the number of commands that can run at the same time in each session to the specified value. The default value is 1000." }, { "name": "-MaxConcurrentUsers", @@ -35,7 +35,7 @@ "name": "System.Nullable`1[System.Int32]" } ], - "description": "Limits the idle time-out set for each session to the specified value. The default value is `[Int]::MaxValue` (~25 days).\n" + "description": "Limits the idle time-out set for each session to the specified value. The default value is `[int]::MaxValue` (~25 days)." }, { "name": "-MaxMemoryPerSessionMB", @@ -44,7 +44,7 @@ "name": "System.Nullable`1[System.Int32]" } ], - "description": "Limits the memory used by each session to the specified value. Enter a value in megabytes. The default value is 1024 megabytes (1 GB).\n" + "description": "Limits the memory used by each session to the specified value. Enter a value in megabytes. The default value is 1024 megabytes (1 GB)." }, { "name": "-MaxProcessesPerSession", @@ -53,7 +53,7 @@ "name": "System.Nullable`1[System.Int32]" } ], - "description": "Limits the number of processes running in each session to the specified value. The default value is 15.\n" + "description": "Limits the number of processes running in each session to the specified value. The default value is 15." }, { "name": "-MaxSessions", @@ -62,7 +62,7 @@ "name": "System.Nullable`1[System.Int32]" } ], - "description": "Limits the number of sessions that use the session configuration. The default value is 25.\n" + "description": "Limits the number of sessions that use the session configuration. The default value is 25." }, { "name": "-MaxSessionsPerUser", @@ -71,27 +71,16 @@ "name": "System.Nullable`1[System.Int32]" } ], - "description": "Limits the number of sessions that use the session configuration and run with the credentials of a given user to the specified value. The default value is 25.\n" + "description": "Limits the number of sessions that use the session configuration and run with the credentials of a given user to the specified value. The default value is 25." }, { "name": "-OutputBufferingMode", "args": [ { - "name": "System.Nullable`1[System.Management.Automation.Runspaces.OutputBufferingMode]", - "suggestions": [ - { - "name": "None" - }, - { - "name": "Drop" - }, - { - "name": "Block" - } - ] + "name": "System.Nullable`1[System.Management.Automation.Runspaces.OutputBufferingMode]" } ], - "description": "Determines how command output is managed in disconnected sessions when the output buffer becomes full. The acceptable values for this parameter are:\n" + "description": "Determines how command output is managed in disconnected sessions when the output buffer becomes full. The acceptable values for this parameter are:" }, { "name": "-ProcessIdleTimeoutSec", @@ -100,7 +89,7 @@ "name": "System.Nullable`1[System.Int32]" } ], - "description": "Limits the time-out for each host process to the specified value. The default value, 0, means that there is no time-out value for the process.\n" + "description": "Limits the time-out for each host process to the specified value. The default value, 0, means that there is no time-out value for the process." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/new-psworkflowexecutionoption.json b/command-signatures/json/autogenerated/powershell/new-psworkflowexecutionoption.json new file mode 100644 index 00000000..d51e4869 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-psworkflowexecutionoption.json @@ -0,0 +1,300 @@ +{ + "name": "New-PSWorkflowExecutionOption", + "options": [ + { + "name": "-ActivityProcessIdleTimeoutSec", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-AllowedActivity", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-EnableValidation" + }, + { + "name": "-MaxActivityProcesses", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-MaxConnectedSessions", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-MaxDisconnectedSessions", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-MaxPersistenceStoreSizeGB", + "args": [ + { + "name": "long" + } + ] + }, + { + "name": "-MaxRunningWorkflows", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-MaxSessionsPerRemoteNode", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-MaxSessionsPerWorkflow", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-OutOfProcessActivity", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-PersistWithEncryption" + }, + { + "name": "-PersistencePath", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-RemoteNodeSessionIdleTimeoutSec", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-SessionThrottleLimit", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-WorkflowShutdownTimeoutMSec", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "New-PSWorkflowExecutionOption [-PersistencePath ] [-MaxPersistenceStoreSizeGB ] [-PersistWithEncryption] [-MaxRunningWorkflows ] [-AllowedActivity ] [-OutOfProcessActivity ] [-EnableValidation] [-MaxDisconnectedSessions ] [-MaxConnectedSessions ] [-MaxSessionsPerWorkflow ] [-MaxSessionsPerRemoteNode ] [-MaxActivityProcesses ] [-ActivityProcessIdleTimeoutSec ] [-RemoteNodeSessionIdleTimeoutSec ] [-SessionThrottleLimit ] [-WorkflowShutdownTimeoutMSec ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-scheduledjoboption.json b/command-signatures/json/autogenerated/powershell/new-scheduledjoboption.json new file mode 100644 index 00000000..75e5f803 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-scheduledjoboption.json @@ -0,0 +1,182 @@ +{ + "name": "New-ScheduledJobOption", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "New-ScheduledJobOption", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-selfsignedcertificate.json b/command-signatures/json/autogenerated/powershell/new-selfsignedcertificate.json new file mode 100644 index 00000000..67223459 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-selfsignedcertificate.json @@ -0,0 +1,645 @@ +{ + "name": "New-SelfSignedCertificate", + "options": [ + { + "name": "-AlternateSignatureAlgorithm", + "description": "Indicates that this cmdlet uses RSA-PSS (PKCSv2.1) or an elliptic curve cryptography (ECC) equivalent. If you do not specify this parameter, the cmdlet uses the default, RSA-PSS (PKCSv1.5) or an ECC equivalent." + }, + { + "name": "-CertStoreLocation", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the certificate store in which to store the new certificate. If the current path is `Cert:\\CurrentUser` or `Cert:\\CurrentUser\\My`, the default store is `Cert:\\CurrentUser\\My`. If the current path is `Cert:\\LocalMachine` or `Cert:\\LocalMachine\\My`, the default store is `Cert:\\LocalMachine\\My`. Otherwise, you must specify `Cert:\\CurrentUser\\My` or `Cert:\\LocalMachine\\My` for this parameter. This parameter does not support other certificate stores." + }, + { + "name": "-CloneCert", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.Certificate" + } + ], + "description": "Identifies the certificate to copy when creating a new certificate. The certificate being cloned can be identified by an X509 certificate or the file path in the certificate provider. When this parameter is used, all fields and extensions of the certificate will be inherited except the NotAfter and NotBefore fields and the public key. A new key of the same algorithm and length will be created. The default validity period will be the same as the certificate to copy, except that the NotBefore field will be set to ten minutes in the past." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Container", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the container in which this cmdlet stores the key for the new certificate." + }, + { + "name": "-CurveExport", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.CurveParametersExportType", + "suggestions": [ + { + "name": "None" + }, + { + "name": "CurveParameters" + }, + { + "name": "CurveName" + } + ] + } + ], + "description": "Specifies how the public key parameters for an elliptic curve key are represented in the new certificate. The acceptable values for this parameter are:" + }, + { + "name": "-DnsName", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies one or more DNS names to put into the subject alternative name extension of the certificate when a certificate to be copied is not specified via the CloneCert parameter. The first DNS name is also saved as the Subject Name. If no signing certificate is specified, the first DNS name is also saved as the Issuer Name." + }, + { + "name": "-ExistingKey", + "description": "Indicates that this cmdlet uses an existing key. If you do not specify this parameter, this cmdlet creates a new key. Creating a certificate from an existing key creates a new key with a new container." + }, + { + "name": "-Extension", + "args": [ + { + "name": "System.Security.Cryptography.X509Certificates.X509Extension[]" + } + ], + "description": "Specifies an array of certificate extensions, as X509Extension objects, that this cmdlet includes in the new certificate." + }, + { + "name": "-FriendlyName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a friendly name for the new certificate." + }, + { + "name": "-HardwareKeyUsage", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.HardwareKeyUsage[]", + "suggestions": [ + { + "name": "None" + }, + { + "name": "SignatureKey" + }, + { + "name": "EncryptionKey" + }, + { + "name": "GenericKey" + }, + { + "name": "StorageKey" + }, + { + "name": "IdentityKey" + } + ] + } + ], + "description": "Specifies how a hardware key associated with the new certificate may be used. This parameter applies only when you specify the `Microsoft Platform Crypto Provider`. The acceptable values for this parameter are:" + }, + { + "name": "-HashAlgorithm", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the hash algorithm to use to sign the new certificate. The default hash algorithm depends on the provider that stores the private key used to sign the new certificate." + }, + { + "name": "-KeyAlgorithm", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the algorithm that creates the asymmetric keys that are associated with the new certificate. Available asymmetric key algorithms are RSA and Elliptic Curve Digital Signature Algorithms (ECDSA)." + }, + { + "name": "-KeyDescription", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a description for the private key that is associated with the new certificate." + }, + { + "name": "-KeyExportPolicy", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.KeyExportPolicy[]", + "suggestions": [ + { + "name": "NonExportable" + }, + { + "name": "ExportableEncrypted" + }, + { + "name": "Exportable" + } + ], + "default": "ExportableEncrypted" + } + ], + "description": "Specifies the policy that governs the export of the private key that is associated with the certificate." + }, + { + "name": "-KeyFriendlyName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a friendly name for the private key that is associated with the new certificate." + }, + { + "name": "-KeyLength", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies the length, in bits, of the key that is associated with the new certificate." + }, + { + "name": "-KeyLocation", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the file system location where this cmdlet stores the private keys associated with the new certificate. Specify this parameter only when you specify the `Microsoft Platform Crypto Provider`." + }, + { + "name": "-KeyProtection", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.KeyProtection[]", + "suggestions": [ + { + "name": "None" + }, + { + "name": "Protect" + }, + { + "name": "ProtectHigh" + }, + { + "name": "ProtectFingerPrint" + } + ] + } + ], + "description": "Specifies the level of protection required to access the private key that is associated with the certificate. The acceptable values for this parameter are:" + }, + { + "name": "-KeySpec", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.KeySpec", + "suggestions": [ + { + "name": "None" + }, + { + "name": "KeyExchange" + }, + { + "name": "Signature" + } + ] + } + ], + "description": "Specifies whether the private key associated with the new certificate can be used for signing, encryption, or both. The acceptable values for this parameter are:" + }, + { + "name": "-KeyUsage", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.KeyUsage[]", + "suggestions": [ + { + "name": "None" + }, + { + "name": "EncipherOnly" + }, + { + "name": "CRLSign" + }, + { + "name": "CertSign" + }, + { + "name": "KeyAgreement" + }, + { + "name": "DataEncipherment" + }, + { + "name": "KeyEncipherment" + }, + { + "name": "NonRepudiation" + }, + { + "name": "DigitalSignature" + }, + { + "name": "DecipherOnly" + } + ], + "default": "DigitalSignature,KeyEncipherment" + } + ], + "description": "Specifies the key usages set in the key usage extension of the certificate. The acceptable values for this parameter are:" + }, + { + "name": "-KeyUsageProperty", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.KeyUsageProperty[]", + "suggestions": [ + { + "name": "None" + }, + { + "name": "Decrypt" + }, + { + "name": "Sign" + }, + { + "name": "KeyAgreement" + }, + { + "name": "All" + } + ] + } + ], + "description": "Specifies the key usages for the key usages property of the private key. The acceptable values for this parameter are:" + }, + { + "name": "-NotAfter", + "args": [ + { + "name": "System.DateTime" + } + ], + "description": "Specifies the date and time, as a DateTime object, that the certificate expires. To obtain a DateTime object, use the `Get-Date` cmdlet. The default value for this parameter is one year after the certificate was created." + }, + { + "name": "-NotBefore", + "args": [ + { + "name": "System.DateTime" + } + ], + "description": "Specifies the date and time, as a DateTime object, when the certificate becomes valid. The default value for this parameter is 10 minutes before the certificate was created." + }, + { + "name": "-Pin", + "args": [ + { + "name": "System.SecureString" + } + ], + "description": "Specifies the personal identification number (PIN) used to access the private key of the new certificate." + }, + { + "name": "-Provider", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the KSP or CSP that this cmdlet uses to create the certificate. See Cryptographic Providers (/windows/desktop/SecCertEnroll/understanding-cryptographic-providers)for more information. Some acceptable values include:" + }, + { + "name": "-Reader", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the smart card reader on which to store the private key for the new certificate." + }, + { + "name": "-SecurityDescriptor", + "args": [ + { + "name": "System.Security.AccessControl.FileSecurity" + } + ], + "description": "Specifies the private key security descriptor as a FileSecurity object. Read access is required to use the private key. This parameter does not apply to providers that do not support security descriptors on private keys, including the smart card CSP and smart card KSP." + }, + { + "name": "-SerialNumber", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a serial number, as a hexadecimal string, that is associated with the new certificate. If you do not specify this parameter, this cmdlet assigns a pseudo-randomly generated 16-byte value." + }, + { + "name": "-Signer", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.Certificate" + } + ], + "description": "Specifies a Certificate object with which this cmdlet signs the new certificate. This value must be in the Personal certificate store of the user or device. This cmdlet must have read access to the private key of the certificate." + }, + { + "name": "-SignerPin", + "args": [ + { + "name": "System.SecureString" + } + ], + "description": "Specifies the PIN that is required to access the private key of the certificate that is used to sign the new certificate." + }, + { + "name": "-SignerReader", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the smart card reader that is used to sign the new certificate." + }, + { + "name": "-SmimeCapabilities", + "description": "Indicates that the new certificate includes available encryption algorithms to a Secure/Multipurpose Internet Mail Extensions (S/MIME) capabilities extension." + }, + { + "name": "-Subject", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the string that appears in the subject of the new certificate. This cmdlet prefixes `CN=` to any value that does not contain an equal sign. For multiple subject relative distinguished names (also known as RDNs), separate each subject relative distinguished name with a comma (`,`). If the value of the relative distinguished name contains commas, separate each subject relative distinguished name with a semicolon (`;`)." + }, + { + "name": "-SuppressOid", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies an array of object identifier (also known as OID) strings that identify default extensions to be removed from the new certificate." + }, + { + "name": "-TestRoot", + "description": "Indicates that this cmdlet signs the new certificate by using a built-in test certificate. This cmdlet adds the built-in test certificate to the intermediate certification authority (CA) certificate store of the device." + }, + { + "name": "-TextExtension", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies an array of certificate extensions, as strings, which this cmdlet includes in the new certificate. Each string must employ one of the following formats:" + }, + { + "name": "-Type", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.CertificateType", + "suggestions": [ + { + "name": "Custom" + }, + { + "name": "CodeSigningCert" + }, + { + "name": "DocumentEncryptionCert" + }, + { + "name": "SSLServerAuthentication" + }, + { + "name": "DocumentEncryptionCertLegacyCsp" + } + ], + "default": "SSLServerAuthentication" + } + ], + "description": "Specifies the type of certificate that this cmdlet creates." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Creates a new self-signed certificate for testing purposes.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-service.json b/command-signatures/json/autogenerated/powershell/new-service.json new file mode 100644 index 00000000..b7317621 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-service.json @@ -0,0 +1,305 @@ +{ + "name": "New-Service", + "options": [ + { + "name": [ + "-BinaryPathName", + "-Path" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the path of the executable file for the service. This parameter is required." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies the account used by the service as the [Service Logon Account](/windows/desktop/ad/about-service-logon-accounts)." + }, + { + "name": "-DependsOn", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the names of other services upon which the new service depends. To enter multiple service names, use a comma to separate the names." + }, + { + "name": "-Description", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a description of the service." + }, + { + "name": "-DisplayName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a display name for the service." + }, + { + "name": [ + "-Name", + "-ServiceName" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the service. This parameter is required." + }, + { + "name": [ + "-SecurityDescriptorSddl", + "-sd" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the SecurityDescriptor for the service in Sddl format." + }, + { + "name": "-StartupType", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.ServiceStartupType", + "suggestions": [ + { + "name": "Automatic" + }, + { + "name": "AutomaticDelayedStart" + }, + { + "name": "Disabled" + }, + { + "name": "InvalidValue" + }, + { + "name": "Manual" + } + ] + } + ], + "description": "Sets the startup type of the service. The acceptable values for this parameter are:" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the name of the service. This parameter is required." + }, + { + "name": "-BinaryPathName", + "description": "Specifies the path of the executable file for the service. This parameter is required." + } + ], + "description": "Creates a new Windows service.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-timespan.json b/command-signatures/json/autogenerated/powershell/new-timespan.json index c6c3d57b..a020e2d3 100644 --- a/command-signatures/json/autogenerated/powershell/new-timespan.json +++ b/command-signatures/json/autogenerated/powershell/new-timespan.json @@ -14,8 +14,7 @@ "name": "-End", "args": [ { - "name": "System.DateTime", - "default": "Current date and time" + "name": "System.DateTime" } ], "description": "Specifies the end of a time span. The default value is the current date and time." @@ -63,11 +62,10 @@ ], "args": [ { - "name": "System.DateTime", - "default": "Current date and time" + "name": "System.DateTime" } ], - "description": "Specifies the start of a time span. Enter a string that represents the date and time, such as \"3/15/09\" or a DateTime object, such as one from a `Get-Date` command. The default value is the current date and time.\n" + "description": "Specifies the start of a time span. Enter a string that represents the date and time, such as \"3/15/09\" or a DateTime object, such as one from a `Get-Date` command. The default value is the current date and time." }, { "name": [ @@ -243,7 +241,7 @@ "args": [ { "name": "-Start", - "description": "Specifies the start of a time span. Enter a string that represents the date and time, such as \"3/15/09\" or a DateTime object, such as one from a `Get-Date` command. The default value is the current date and time.\n" + "description": "Specifies the start of a time span. Enter a string that represents the date and time, such as \"3/15/09\" or a DateTime object, such as one from a `Get-Date` command. The default value is the current date and time." }, { "name": "-End", diff --git a/command-signatures/json/autogenerated/powershell/new-tlssessionticketkey.json b/command-signatures/json/autogenerated/powershell/new-tlssessionticketkey.json new file mode 100644 index 00000000..951ef7f9 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-tlssessionticketkey.json @@ -0,0 +1,213 @@ +{ + "name": "New-TlsSessionTicketKey", + "options": [ + { + "name": "-Password", + "args": [ + { + "name": "System.Security.SecureString" + } + ], + "isRequired": true, + "description": "Specifies the password, as a secure string, for the configuration file of the TLS server." + }, + { + "name": [ + "-Path", + "-FullName" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the path of the configuration file for the TLS server. The cmdlet outputs the generated configuration file to this path." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Password", + "description": "Specifies the password, as a secure string, for the configuration file of the TLS server." + }, + { + "name": "-Path", + "description": "Specifies the path of the configuration file for the TLS server. The cmdlet outputs the generated configuration file to this path." + } + ], + "description": "Creates a TLS session ticket key configuration file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-variable.json b/command-signatures/json/autogenerated/powershell/new-variable.json index 1629bc55..04731b9d 100644 --- a/command-signatures/json/autogenerated/powershell/new-variable.json +++ b/command-signatures/json/autogenerated/powershell/new-variable.json @@ -1,6 +1,13 @@ { "name": "New-Variable", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Description", "args": [ @@ -12,7 +19,7 @@ }, { "name": "-Force", - "description": "Indicates that the cmdlet creates a variable with the same name as an existing read-only variable.\n" + "description": "Indicates that the cmdlet creates a variable with the same name as an existing read-only variable." }, { "name": "-Name", @@ -31,19 +38,19 @@ "name": "System.Management.Automation.ScopedItemOptions", "suggestions": [ { - "name": "None" + "name": "AllScope" }, { - "name": "ReadOnly" + "name": "Constant" }, { - "name": "Constant" + "name": "None" }, { "name": "Private" }, { - "name": "AllScope" + "name": "ReadOnly" }, { "name": "Unspecified" @@ -51,7 +58,7 @@ ] } ], - "description": "Specifies the value of the Options property of the variable. The acceptable values for this parameter are:\n" + "description": "Specifies the value of the Options property of the variable. The acceptable values for this parameter are:" }, { "name": "-PassThru", @@ -64,7 +71,7 @@ "name": "System.String" } ], - "description": "Specifies the scope of the new variable. The acceptable values for this parameter are:\n" + "description": "Specifies the scope of the new variable. The acceptable values for this parameter are:" }, { "name": "-Value", @@ -82,22 +89,15 @@ "name": "System.Management.Automation.SessionStateEntryVisibility", "suggestions": [ { - "name": "Public" + "name": "Private" }, { - "name": "Private" + "name": "Public" } ] } ], - "description": "Determines whether the variable is visible outside of the session in which it was created. This parameter is designed for use in scripts and commands that will be delivered to other users. The acceptable values for this parameter are:\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Determines whether the variable is visible outside of the session in which it was created. This parameter is designed for use in scripts and commands that will be delivered to other users. The acceptable values for this parameter are:" }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/new-webserviceproxy.json b/command-signatures/json/autogenerated/powershell/new-webserviceproxy.json new file mode 100644 index 00000000..887d732f --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-webserviceproxy.json @@ -0,0 +1,246 @@ +{ + "name": "New-WebServiceProxy", + "options": [ + { + "name": [ + "-Class", + "-FileName", + "-FN" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Credential", + "-Cred" + ], + "args": [ + { + "name": "pscredential" + } + ] + }, + { + "name": [ + "-Namespace", + "-NS" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Uri", + "-WL", + "-WSDL", + "-Path" + ], + "args": [ + { + "name": "uri" + } + ], + "isRequired": true + }, + { + "name": [ + "-UseDefaultCredential", + "-UDC" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Uri" + }, + { + "name": "-Class" + }, + { + "name": "-Namespace" + } + ], + "description": "New-WebServiceProxy [-Uri] [[-Class] ] [[-Namespace] ] [] New-WebServiceProxy [-Uri] [[-Class] ] [[-Namespace] ] [-Credential ] [] New-WebServiceProxy [-Uri] [[-Class] ] [[-Namespace] ] [-UseDefaultCredential] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-windowscustomimage.json b/command-signatures/json/autogenerated/powershell/new-windowscustomimage.json new file mode 100644 index 00000000..82d6c2c2 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-windowscustomimage.json @@ -0,0 +1,256 @@ +{ + "name": "New-WindowsCustomImage", + "options": [ + { + "name": "-CapturePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the drive or path to the Windows operating system that is to be captured to an image file." + }, + { + "name": "-CheckIntegrity", + "description": "Detects and tracks .wim file corruption when used with the Add-WindowsImage, Dismount-WindowsImage, or Save-WindowsImage cmdlet. CheckIntegrity stops the operation if DISM detects that the .wim file is corrupted when used with the Expand-WindowsImage or Mount-WindowsImage cmdlet." + }, + { + "name": "-ConfigFilePath", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location of a configuration file that lists exclusions for image capture and compress commands. For more information, see [DISM Configuration List and WimScript.ini Files](https://go.microsoft.com/fwlink/?LinkID=313768)." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-Verify", + "description": "Checks for errors and file duplication. During an apply operation, for example, using the Add-WindowsImage cmdlet, the size and the hash of the file being applied are checked against the image file to verify they are both equal. During a capture operation, for example, when using the New-WindowsImage cmdlet, after the files is captured into a Windows image, the file is written to a temporary file and compared on a bit-by-bit basis with the original file." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Captures an image of customized or serviced Windows components on a Windows Image File Boot (WIMBoot) configured device.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-windowsimage.json b/command-signatures/json/autogenerated/powershell/new-windowsimage.json new file mode 100644 index 00000000..fdb3ab81 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-windowsimage.json @@ -0,0 +1,313 @@ +{ + "name": "New-WindowsImage", + "options": [ + { + "name": "-CapturePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the drive or path to the Windows operating system that is to be captured to an image file." + }, + { + "name": "-CheckIntegrity", + "description": "Detects and tracks .wim file corruption when used with the Add-WindowsImage, Dismount-WindowsImage, or Save-WindowsImage cmdlet. CheckIntegrity stops the operation if DISM detects that the .wim file is corrupted when used with the Expand-WindowsImage or Mount-WindowsImage cmdlet." + }, + { + "name": "-CompressionType", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the type of compression used for the initial capture operation:" + }, + { + "name": "-ConfigFilePath", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location of a configuration file that lists exclusions for image capture commands and compress commands. For more information, see [DISM Configuration List and WimScript.ini Files](https://go.microsoft.com/fwlink/?LinkID=313768) in the TechNet Library." + }, + { + "name": "-Description", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the description of the image to be captured." + }, + { + "name": "-ImagePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location of a WIM file." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is WarningsInfo. The accepted values are as follows:" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Name", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the name of an image in a WIM file." + }, + { + "name": "-NoRpFix", + "description": "Disables the reparse point tag fix. A reparse point is a file that contains a link to another file on the file system. If the parameter is not specified, reparse points that resolve to paths outside of the value specified by the *ImagePath* parameter will not be captured." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": [ + "-Setbootable", + "-SB" + ], + "description": "Marks a volume image as being a bootable image. This argument is available only for Windows PE images. Only one volume image can be marked as bootable in a .wim file." + }, + { + "name": "-SupportEa", + "description": "Captures extended attributes. The switch must be explicitly specified to capture extended attributes. DISM captures extended attribute bits if they are set in the components to be captured in the WIM image. If the bits are not set, DISM won't set them. Only the inbox components of CAB packages and drivers will have these extended attribute bits, not the AppX package components or Win32 application components. Extended attributes with the prefix `$Kernel.` in their name are skipped because only user mode extended attributes are captured." + }, + { + "name": "-Verify", + "description": "Checks for errors and file duplication. During an apply operation, for example, using the Add-WindowsImage cmdlet, the size and the hash of the file being applied are checked against the image file to verify they are both equal. During a capture operation, for example, when using the New-WindowsImage cmdlet, after the file is captured into a Windows image, the file is written to a temporary file and compared on a bit-by-bit basis with the original file." + }, + { + "name": "-WIMBoot", + "description": "Specifies that the image will be formatted to install on a Windows Image Format Boot (WIMBoot) system." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Captures an image of a drive to a new WIM file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-winevent.json b/command-signatures/json/autogenerated/powershell/new-winevent.json new file mode 100644 index 00000000..d17a98c9 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-winevent.json @@ -0,0 +1,233 @@ +{ + "name": "New-WinEvent", + "options": [ + { + "name": "-Id", + "args": [ + { + "name": "System.Int32" + } + ], + "isRequired": true, + "description": "Specifies an event Id that is registered in the event provider." + }, + { + "name": "-Payload", + "args": [ + { + "name": "System.Object[]" + } + ], + "description": "The payload is an array of values passed as positional arguments to the event template. The values are inserted into the template to construct the message for the event. Events can have multiple template versions that use different formats." + }, + { + "name": "-ProviderName", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the event provider that writes the event to an event log, such as \"Microsoft-Windows-PowerShell\". An ETW event provider is a logical entity that writes events to ETW sessions." + }, + { + "name": "-Version", + "args": [ + { + "name": "System.Byte" + } + ], + "description": "Specifies the version number of the event. PowerShell converts the number to the required Byte type. The value specifies the version of the event when different versions of the same event are defined." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ProviderName", + "description": "Specifies the event provider that writes the event to an event log, such as \"Microsoft-Windows-PowerShell\". An ETW event provider is a logical entity that writes events to ETW sessions." + }, + { + "name": "-Id", + "description": "Specifies an event Id that is registered in the event provider." + }, + { + "name": "-Payload", + "description": "The payload is an array of values passed as positional arguments to the event template. The values are inserted into the template to construct the message for the event. Events can have multiple template versions that use different formats." + } + ], + "description": "Creates a new Windows event for the specified event provider.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-winuserlanguagelist.json b/command-signatures/json/autogenerated/powershell/new-winuserlanguagelist.json new file mode 100644 index 00000000..c756bae1 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-winuserlanguagelist.json @@ -0,0 +1,197 @@ +{ + "name": "New-WinUserLanguageList", + "options": [ + { + "name": "-Language", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a language." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Language", + "description": "Specifies a language." + } + ], + "description": "Instantiates a new language list object.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-wsmaninstance.json b/command-signatures/json/autogenerated/powershell/new-wsmaninstance.json new file mode 100644 index 00000000..1ba25d86 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-wsmaninstance.json @@ -0,0 +1,367 @@ +{ + "name": "New-WSManInstance", + "options": [ + { + "name": "-ApplicationName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the application name in the connection. The default value of the ApplicationName parameter is WSMAN. The complete identifier for the remote endpoint is in the following format:" + }, + { + "name": [ + "-Authentication", + "-auth", + "-am" + ], + "args": [ + { + "name": "Microsoft.WSMan.Management.AuthenticationMechanism", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "ClientCertificate" + }, + { + "name": "Credssp" + }, + { + "name": "Default" + }, + { + "name": "Digest" + }, + { + "name": "Kerberos" + }, + { + "name": "Negotiate" + }, + { + "name": "None" + } + ] + } + ], + "description": "Specifies the authentication mechanism to be used at the server. Possible values are:" + }, + { + "name": "-CertificateThumbprint", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to perform this action. Enter the certificate thumbprint of the certificate." + }, + { + "name": [ + "-ComputerName", + "-cn" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the computer against which you want to run the management operation. The value can be a fully qualified domain name, a NetBIOS name, or an IP address. Use the local computer name, use localhost, or use a dot (`.`) to specify the local computer. The local computer is the default. When the remote computer is in a different domain from the user, you must use a fully qualified domain name must be used. You can pipe a value for this parameter to the cmdlet." + }, + { + "name": [ + "-ConnectionURI", + "-CURI", + "-CU" + ], + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the connection endpoint. The format of this string is:" + }, + { + "name": [ + "-Credential", + "-cred", + "-c" + ], + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to perform this action. The default is the current user. Type a user name, such as \"User01\", \"Domain01\\User01\", or \"User@Domain.com\". Or, enter a PSCredential object, such as one returned by the `Get-Credential` cmdlet. When you type a user name, you will be prompted for a password." + }, + { + "name": [ + "-FilePath", + "-Path" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the path of a file that is used to create a management resource. You specify the management resource using the ResourceURI parameter and the SelectorSet parameter . For example, the following command uses the File parameter:" + }, + { + "name": [ + "-OptionSet", + "-os" + ], + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "description": "Passes a set of switches to a service to modify or refine the nature of the request. These are similar to switches used in command-line shells because they are service specific. Any number of options can be specified." + }, + { + "name": "-Port", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies the port to use when the client connects to the WinRM service. When the transport is HTTP, the default port is 80. When the transport is HTTPS, the default port is 443." + }, + { + "name": [ + "-ResourceURI", + "-ruri" + ], + "args": [ + { + "name": "System.Uri" + } + ], + "isRequired": true, + "description": "Contains the Uniform Resource Identifier (URI) of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": "-SelectorSet", + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "isRequired": true, + "description": "Specifies a set of value pairs that are used to select particular management resource instances. The SelectorSet parameter is used when more than one instance of the resource exists. The value of the SelectorSet parameter must be a hash table." + }, + { + "name": [ + "-SessionOption", + "-so" + ], + "args": [ + { + "name": "Microsoft.WSMan.Management.SessionOption" + } + ], + "description": "Defines a set of extended options for the WS-Management session. Enter a SessionOption object that you create using the `New-WSManSessionOption` cmdlet. For more information about the options that are available, see `New-WSManSessionOption`." + }, + { + "name": "-UseSSL", + "description": "Specifies that the Secure Sockets Layer (SSL) protocol should be used to establish a connection to the remote computer. By default, SSL is not used." + }, + { + "name": "-ValueSet", + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "description": "Specifies a hash table that helps modify a management resource. You specify the management resource using the ResourceURI parameter and the SelectorSet parameter. The value of the ValueSet parameter must be a hash table." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ResourceURI", + "description": "Contains the Uniform Resource Identifier (URI) of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": "-SelectorSet", + "description": "Specifies a set of value pairs that are used to select particular management resource instances. The SelectorSet parameter is used when more than one instance of the resource exists. The value of the SelectorSet parameter must be a hash table." + } + ], + "description": "Creates a new instance of a management resource.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/new-wsmansessionoption.json b/command-signatures/json/autogenerated/powershell/new-wsmansessionoption.json new file mode 100644 index 00000000..2f7726c2 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/new-wsmansessionoption.json @@ -0,0 +1,275 @@ +{ + "name": "New-WSManSessionOption", + "options": [ + { + "name": "-NoEncryption", + "description": "Indicates that the connection does not use encryption for remote operations over HTTP." + }, + { + "name": [ + "-OperationTimeout", + "-OperationTimeoutMSec" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies the time-out, in milliseconds, for the WS-Management operation." + }, + { + "name": "-ProxyAccessType", + "args": [ + { + "name": "Microsoft.WSMan.Management.ProxyAccessType", + "suggestions": [ + { + "name": "ProxyAutoDetect" + }, + { + "name": "ProxyIEConfig" + }, + { + "name": "ProxyNoProxyServer" + }, + { + "name": "ProxyWinHttpConfig" + } + ] + } + ], + "description": "Specifies the mechanism by which the proxy server is located. The acceptable values for this parameter are:" + }, + { + "name": "-ProxyAuthentication", + "args": [ + { + "name": "Microsoft.WSMan.Management.ProxyAuthentication", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "Digest" + }, + { + "name": "Negotiate" + } + ] + } + ], + "description": "Specifies the authentication method to use at the proxy. The acceptable values for this parameter are:" + }, + { + "name": "-ProxyCredential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to gain access through an intermediate Web proxy." + }, + { + "name": "-SkipCACheck", + "description": "Specifies that, when it connects over HTTPS, the client does not validate that the server certificate is signed by a trusted certification authority (CA). Use this option only when the remote computer is trusted by another method, for example, if the remote computer is part of a network that is physically secure and isolated or the remote computer is listed as a trusted host in the WS-Management configuration." + }, + { + "name": "-SkipCNCheck", + "description": "Specifies that the certificate common name (CN) of the server does not have to match the host name of the server. This is used only in remote operations using HTTPS. This option should only be used for trusted computers." + }, + { + "name": "-SkipRevocationCheck", + "description": "Indicates that the connection does not validate the revocation status on the server certificate." + }, + { + "name": "-SPNPort", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies a port number to append to the connection Service Principal Name (SPN) of the remote server. An SPN is used when the authentication mechanism is Kerberos or Negotiate." + }, + { + "name": "-UseUTF16", + "description": "Indicates that the connection encodes the request in UTF16 format instead of UTF8 format. The default is UTF8 encoding." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Creates session option hash table to use as input parameters for WS-Management cmdlets.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/optimize-appxprovisionedpackages.json b/command-signatures/json/autogenerated/powershell/optimize-appxprovisionedpackages.json new file mode 100644 index 00000000..146582a6 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/optimize-appxprovisionedpackages.json @@ -0,0 +1,262 @@ +{ + "name": "Optimize-AppXProvisionedPackages", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Do not use. Optimize-AppXProvisionedPackages can't optimize provisioned AppX packages if the image is online." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Optimizes the total file size of provisioned packages on the image by replacing identical files with hard links.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/optimize-windowsimage.json b/command-signatures/json/autogenerated/powershell/optimize-windowsimage.json new file mode 100644 index 00000000..50d087fb --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/optimize-windowsimage.json @@ -0,0 +1,275 @@ +{ + "name": "Optimize-WindowsImage", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-OptimizationTarget", + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "Boot" + }, + { + "name": "WIMBoot" + } + ] + } + ], + "isRequired": true, + "description": "Specifies the Windows image optimization type. The accepted values are as follows: \"WIMBoot\". Note: This value must be entered as a string value." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Configures a Windows image with specified optimizations.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/out-default.json b/command-signatures/json/autogenerated/powershell/out-default.json index 34dc36d2..b108d566 100644 --- a/command-signatures/json/autogenerated/powershell/out-default.json +++ b/command-signatures/json/autogenerated/powershell/out-default.json @@ -12,7 +12,7 @@ }, { "name": "-Transcript", - "description": "Determines whether the output should be sent to PowerShell's transcription services." + "description": "When you use this parameter, the output is only sent to the PowerShell transcript." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/out-file.json b/command-signatures/json/autogenerated/powershell/out-file.json index 294d2449..6b8cd783 100644 --- a/command-signatures/json/autogenerated/powershell/out-file.json +++ b/command-signatures/json/autogenerated/powershell/out-file.json @@ -5,6 +5,13 @@ "name": "-Append", "description": "Adds the output to the end of an existing file." }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Encoding", "args": [ @@ -12,40 +19,42 @@ "name": "System.Text.Encoding", "suggestions": [ { - "name": "ASCII" + "name": "ansi" + }, + { + "name": "ascii" }, { - "name": "BigEndianUnicode" + "name": "bigendianunicode" }, { - "name": "BigEndianUTF32" + "name": "bigendianutf32" }, { - "name": "OEM" + "name": "oem" }, { - "name": "Unicode" + "name": "unicode" }, { - "name": "UTF7" + "name": "utf32" }, { - "name": "UTF8" + "name": "utf7" }, { - "name": "UTF8BOM" + "name": "utf8" }, { - "name": "UTF8NoBOM" + "name": "utf8BOM" }, { - "name": "UTF32" + "name": "utf8NoBOM" } - ], - "default": "UTF8NoBOM" + ] } ], - "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`.\n" + "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`." }, { "name": [ @@ -85,7 +94,7 @@ } ], "isRequired": true, - "description": "Specifies the path to the output file. The LiteralPath parameter is used exactly as it's typed. Wildcard characters aren't accepted. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences. For more information, see about_Quoting_Rules (../Microsoft.Powershell.Core/About/about_Quoting_Rules.md)." + "description": "Specifies the path to the output file. The LiteralPath parameter is used exactly as it's typed. Wildcard characters aren't accepted. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences. For more information, see [about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md)." }, { "name": [ @@ -98,6 +107,13 @@ "name": "-NoNewline", "description": "Specifies that the content written to the file doesn't end with a newline character. The string representations of the input objects are concatenated to form the output. No spaces or newlines are inserted between the output strings. No newline is added after the last output string." }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, { "name": "-Width", "args": [ @@ -105,21 +121,7 @@ "name": "System.Int32" } ], - "description": "Specifies the maximum number of characters in each line of output. Any additional characters are truncated, not wrapped. If this parameter isn't used, the width is determined by the characteristics of the host. The default for the PowerShell console is 80 characters. If you want to control the width for all invocations of `Out-File` as well as the redirection operators (`>` and `>>`), set `$PSDefaultParameterValues['out-file:width'] = 2000` before using `Out-File`." - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, - { - "name": [ - "-WhatIf", - "-wi" - ], - "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + "description": "Specifies the maximum number of characters in each line of output. Any additional characters are truncated, not wrapped. If this parameter isn't used, the width is determined by the characteristics of the host. The default for the PowerShell console is 80 characters. If you want to control the width for all invocations of `Out-File` as well as the redirection operators (`>` and `>>`), set `$PSDefaultParameterValues['Out-File:Width'] = 2000` before using `Out-File`." }, { "name": [ @@ -299,37 +301,40 @@ }, { "name": "-Encoding", - "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`.\n", + "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`.", "suggestions": [ { - "name": "ASCII" + "name": "ansi" + }, + { + "name": "ascii" }, { - "name": "BigEndianUnicode" + "name": "bigendianunicode" }, { - "name": "BigEndianUTF32" + "name": "bigendianutf32" }, { - "name": "OEM" + "name": "oem" }, { - "name": "Unicode" + "name": "unicode" }, { - "name": "UTF7" + "name": "utf32" }, { - "name": "UTF8" + "name": "utf7" }, { - "name": "UTF8BOM" + "name": "utf8" }, { - "name": "UTF8NoBOM" + "name": "utf8BOM" }, { - "name": "UTF32" + "name": "utf8NoBOM" } ] } diff --git a/command-signatures/json/autogenerated/powershell/out-gridview.json b/command-signatures/json/autogenerated/powershell/out-gridview.json new file mode 100644 index 00000000..8c5a0ce1 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/out-gridview.json @@ -0,0 +1,228 @@ +{ + "name": "Out-GridView", + "options": [ + { + "name": "-InputObject", + "args": [ + { + "name": "System.Management.Automation.PSObject" + } + ], + "description": "Specifies object that the cmdlet accepts as input for `Out-GridView`." + }, + { + "name": "-OutputMode", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.OutputModeOption", + "suggestions": [ + { + "name": "Multiple" + }, + { + "name": "None" + }, + { + "name": "Single" + } + ] + } + ], + "description": "Specifies the items that the interactive window sends down the pipeline as input to other commands. By default, this cmdlet does not generate any output. To send items from the interactive window down the pipeline, click to select the items and then click OK." + }, + { + "name": "-PassThru", + "description": "Indicates that the cmdlet sends items from the interactive window down the pipeline as input to other commands. By default, this cmdlet does not generate any output. This parameter is equivalent to using the Multiple value of the OutputMode parameter." + }, + { + "name": "-Title", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the text that appears in the title bar of the `Out-GridView` window. By default, the title bar displays the command that invokes `Out-GridView`." + }, + { + "name": "-Wait", + "description": "Indicates that the cmdlet suppresses the command prompt and prevents Windows PowerShell from closing until the `Out-GridView` window is closed. By default, the command prompt returns when the `Out-GridView` window opens." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Sends output to an interactive table in a separate window.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/out-host.json b/command-signatures/json/autogenerated/powershell/out-host.json index 2f21fff4..750b6d12 100644 --- a/command-signatures/json/autogenerated/powershell/out-host.json +++ b/command-signatures/json/autogenerated/powershell/out-host.json @@ -12,7 +12,7 @@ }, { "name": "-Paging", - "description": "Indicates that `Out-Host` displays one page of output at a time, and waits for user input before the remaining pages are displayed. By default, all the output is displayed on a single page. The page size is determined by the characteristics of the host.\n" + "description": "Indicates that `Out-Host` displays one page of output at a time. The page size is determined by the characteristics of the host." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/out-printer.json b/command-signatures/json/autogenerated/powershell/out-printer.json new file mode 100644 index 00000000..cd0edd7c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/out-printer.json @@ -0,0 +1,208 @@ +{ + "name": "Out-Printer", + "options": [ + { + "name": "-InputObject", + "args": [ + { + "name": "System.Management.Automation.PSObject" + } + ], + "description": "Specifies the objects to be sent to the printer. Enter a variable that contains the objects, or type a command or expression that gets the objects." + }, + { + "name": [ + "-Name", + "-PrinterName" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Sends the output to the specified printer. The parameter name Name is optional." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Sends the output to the specified printer. The parameter name Name is optional." + } + ], + "description": "Sends output to a printer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/out-string.json b/command-signatures/json/autogenerated/powershell/out-string.json index 8a9a38ff..01357648 100644 --- a/command-signatures/json/autogenerated/powershell/out-string.json +++ b/command-signatures/json/autogenerated/powershell/out-string.json @@ -12,7 +12,7 @@ }, { "name": "-NoNewline", - "description": "Removes all newlines from output generated by the PowerShell formatter. Newlines that are part of the string objects are preserved.\n" + "description": "Removes all newlines from output generated by the PowerShell formatter. Newlines that are part of the string objects are preserved." }, { "name": "-Stream", diff --git a/command-signatures/json/autogenerated/powershell/pop-location.json b/command-signatures/json/autogenerated/powershell/pop-location.json index d58e47f8..ce607a26 100644 --- a/command-signatures/json/autogenerated/powershell/pop-location.json +++ b/command-signatures/json/autogenerated/powershell/pop-location.json @@ -12,7 +12,7 @@ "name": "System.String" } ], - "description": "Specifies the location stack from which the location is popped. Enter a location stack name.\n" + "description": "Specifies the location stack from which the location is popped. Enter a location stack name." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/protect-cmsmessage.json b/command-signatures/json/autogenerated/powershell/protect-cmsmessage.json index fdf5a314..fbb77509 100644 --- a/command-signatures/json/autogenerated/powershell/protect-cmsmessage.json +++ b/command-signatures/json/autogenerated/powershell/protect-cmsmessage.json @@ -19,7 +19,7 @@ } ], "isRequired": true, - "description": "Specifies the path to content that you want to encrypt. Unlike Path , the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + "description": "Specifies the path to content that you want to encrypt. Unlike Path, the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-OutFile", @@ -48,7 +48,7 @@ } ], "isRequired": true, - "description": "Specifies one or more CMS message recipients, identified in any of the following formats:\n" + "description": "Specifies one or more CMS message recipients, identified in any of the following formats:" }, { "name": [ @@ -224,7 +224,7 @@ "args": [ { "name": "-To", - "description": "Specifies one or more CMS message recipients, identified in any of the following formats:\n" + "description": "Specifies one or more CMS message recipients, identified in any of the following formats:" }, { "name": "-Content-Or-LiteralPath-Or-Path" diff --git a/command-signatures/json/autogenerated/powershell/publish-psresource.json b/command-signatures/json/autogenerated/powershell/publish-psresource.json index 44ff2ef5..ff38dfc5 100644 --- a/command-signatures/json/autogenerated/powershell/publish-psresource.json +++ b/command-signatures/json/autogenerated/powershell/publish-psresource.json @@ -10,6 +10,13 @@ ], "description": "Specifies the API key that you want to use to publish a resource to the online gallery." }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ @@ -28,6 +35,25 @@ ], "description": "Specifies the path where the NuGet package `.nupkg` file should be saved. This parameter can be used in conjunction with the Repository parameter to publish to a repository and also save the exact same package to the local file system." }, + { + "name": "-ModulePrefix", + "args": [ + { + "name": "System.String" + } + ], + "description": "The value of the parameter is pre-pended to the package name. This information is only used for publishing and isn't included in the package metadata. The module prefix controls the visibility of the module, for example: `internal`, `public`, `staging`." + }, + { + "name": "-NupkgPath", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Path to the `.nupkg` file to be published. The `.nupkg` file could have been created by a previous run of `Publish-PSResource` with the DestinationPath parameter. Or, you can create the `.nupkg` file using the `Compress-PSResource` command." + }, { "name": "-Path", "args": [ @@ -36,7 +62,7 @@ } ], "isRequired": true, - "description": "The path to the module or script file or the path to a folder containing the module or script file to be published." + "description": "The path to the module or script file or the path to a folder containing the module or script file to be published. The cmdlet packages all files in the folder into a `.nupkg` file before publishing to the repository." }, { "name": "-Proxy", @@ -73,13 +99,6 @@ "name": "-SkipModuleManifestValidate", "description": "Skips validating the module manifest before publishing." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", @@ -261,7 +280,7 @@ "args": [ { "name": "-Path", - "description": "The path to the module or script file or the path to a folder containing the module or script file to be published." + "description": "The path to the module or script file or the path to a folder containing the module or script file to be published. The cmdlet packages all files in the folder into a `.nupkg` file before publishing to the repository." } ], "description": "Publishes a specified module from the local computer to PSResource repository.", diff --git a/command-signatures/json/autogenerated/powershell/push-location.json b/command-signatures/json/autogenerated/powershell/push-location.json index 158dbd68..a81ca397 100644 --- a/command-signatures/json/autogenerated/powershell/push-location.json +++ b/command-signatures/json/autogenerated/powershell/push-location.json @@ -31,11 +31,10 @@ "name": "-StackName", "args": [ { - "name": "System.String", - "default": "Default stack" + "name": "System.String" } ], - "description": "Specifies the location stack to which the current location is added. Enter a location stack name. If the stack does not exist, `Push-Location` creates it.\n" + "description": "Specifies the location stack to which the current location is added. Enter a location stack name. If the stack does not exist, `Push-Location` creates it." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/read-host.json b/command-signatures/json/autogenerated/powershell/read-host.json index 0ffd66d6..dc58bb2e 100644 --- a/command-signatures/json/autogenerated/powershell/read-host.json +++ b/command-signatures/json/autogenerated/powershell/read-host.json @@ -3,11 +3,11 @@ "options": [ { "name": "-AsSecureString", - "description": "Indicates that the cmdlet displays asterisks (`*`) in place of the characters that the user types as input. When you use this parameter, the output of the `Read-Host` cmdlet is a SecureString object ( System.Security.SecureString )." + "description": "Indicates that the cmdlet displays asterisks (`*`) in place of the characters that the user types as input. When you use this parameter, the output of the `Read-Host` cmdlet is a SecureString object (System.Security.SecureString)." }, { "name": "-MaskInput", - "description": "Indicates that the cmdlet displays asterisks (`*`) in place of the characters that the user types as input. When you use this parameter, the output of the `Read-Host` cmdlet is a String object. This allows you to safely prompt for a password that is returned as plaintext instead of SecureString .\n" + "description": "Indicates that the cmdlet displays asterisks (`*`) in place of the characters that the user types as input. When you use this parameter, the output of the `Read-Host` cmdlet is a String object. This allows you to safely prompt for a password that is returned as plaintext instead of SecureString." }, { "name": "-Prompt", diff --git a/command-signatures/json/autogenerated/powershell/receive-dtcdiagnostictransaction.json b/command-signatures/json/autogenerated/powershell/receive-dtcdiagnostictransaction.json new file mode 100644 index 00000000..329b3d0a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/receive-dtcdiagnostictransaction.json @@ -0,0 +1,232 @@ +{ + "name": "Receive-DtcDiagnosticTransaction", + "options": [ + { + "name": "-ComputerName", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Port", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-PropagationMethod", + "args": [ + { + "name": "DtcTransactionPropagation", + "suggestions": [ + { + "name": "Pull" + }, + { + "name": "Push" + } + ] + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ComputerName" + }, + { + "name": "-Port" + }, + { + "name": "-PropagationMethod", + "suggestions": [ + { + "name": "Pull" + }, + { + "name": "Push" + } + ] + } + ], + "description": "Receive-DtcDiagnosticTransaction [[-ComputerName] ] [[-Port] ] [[-PropagationMethod] ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/receive-job.json b/command-signatures/json/autogenerated/powershell/receive-job.json index 0e4830ff..4bb63b64 100644 --- a/command-signatures/json/autogenerated/powershell/receive-job.json +++ b/command-signatures/json/autogenerated/powershell/receive-job.json @@ -3,7 +3,7 @@ "options": [ { "name": "-AutoRemoveJob", - "description": "Indicates that this cmdlet deletes the job after it returns the job results. If the job has more results, the job is still deleted, but `Receive-Job` displays a message.\n" + "description": "Indicates that this cmdlet deletes the job after it returns the job results. If the job has more results, the job is still deleted, but `Receive-Job` displays a message." }, { "name": [ @@ -12,15 +12,14 @@ ], "args": [ { - "name": "System.String[]", - "default": "All computers available" + "name": "System.String[]" } ], - "description": "Specifies an array of names of computers.\n" + "description": "Specifies an array of names of computers." }, { "name": "-Force", - "description": "Indicates that this cmdlet continues waiting if jobs are in the Suspended or Disconnected state. By default, the Wait parameter of `Receive-Job` returns, or terminates the wait, when jobs are in one of the following states:\n" + "description": "Indicates that this cmdlet continues waiting if jobs are in the Suspended or Disconnected state. By default, the Wait parameter of `Receive-Job` returns, or terminates the wait, when jobs are in one of the following states:" }, { "name": "-Id", @@ -30,18 +29,17 @@ } ], "isRequired": true, - "description": "Specifies an array of IDs. This cmdlet gets the results of jobs with the specified IDs.\n" + "description": "Specifies an array of IDs. This cmdlet gets the results of jobs with the specified IDs." }, { "name": "-InstanceId", "args": [ { - "name": "System.Guid[]", - "default": "All instances" + "name": "System.Guid[]" } ], "isRequired": true, - "description": "Specifies an array of instance IDs. This cmdlet gets the results of jobs with the specified instance IDs.\n" + "description": "Specifies an array of instance IDs. This cmdlet gets the results of jobs with the specified instance IDs." }, { "name": "-Job", @@ -51,18 +49,17 @@ } ], "isRequired": true, - "description": "Specifies the job for which results are being retrieved.\n" + "description": "Specifies the job for which results are being retrieved." }, { "name": "-Keep", - "description": "Indicates that this cmdlet saves the aggregated stream data in the system, even after you have received them. By default, aggregated stream data is erased after viewed with `Receive-Job`.\n" + "description": "Indicates that this cmdlet saves the aggregated stream data in the system, even after you have received them. By default, aggregated stream data is erased after viewed with `Receive-Job`." }, { "name": "-Location", "args": [ { - "name": "System.String[]", - "default": "All locations" + "name": "System.String[]" } ], "description": "Specifies an array of locations. This cmdlet gets only the results of jobs in the specified locations." @@ -85,23 +82,22 @@ "name": "-Session", "args": [ { - "name": "System.Management.Automation.Runspaces.PSSession[]", - "default": "All sessions" + "name": "System.Management.Automation.Runspaces.PSSession[]" } ], - "description": "Specifies an array of sessions. This cmdlet gets the results of jobs that were run in the specified PowerShell session ( PSSession ). Enter a variable that contains the PSSession or a command that gets the PSSession , such as a `Get-PSSession` command." + "description": "Specifies an array of sessions. This cmdlet gets the results of jobs that were run in the specified PowerShell session (PSSession). Enter a variable that contains the PSSession or a command that gets the PSSession, such as a `Get-PSSession` command." }, { "name": "-Wait", - "description": "Indicates that this cmdlet suppresses the command prompt until all job results are received. By default, `Receive-Job` immediately returns the available results.\n" + "description": "Indicates that this cmdlet suppresses the command prompt until all job results are received. By default, `Receive-Job` immediately returns the available results." }, { "name": "-WriteEvents", - "description": "Indicates that this cmdlet reports changes in the job state while it waits for the job to finish.\n" + "description": "Indicates that this cmdlet reports changes in the job state while it waits for the job to finish." }, { "name": "-WriteJobInResults", - "description": "Indicates that this cmdlet returns the job object followed by the results.\n" + "description": "Indicates that this cmdlet returns the job object followed by the results." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/receive-pssession.json b/command-signatures/json/autogenerated/powershell/receive-pssession.json new file mode 100644 index 00000000..3e781709 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/receive-pssession.json @@ -0,0 +1,390 @@ +{ + "name": "Receive-PSSession", + "options": [ + { + "name": "-AllowRedirection", + "description": "Indicates that this cmdlet allows redirection of this connection to an alternate Uniform Resource Identifier (URI)." + }, + { + "name": "-ApplicationName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies an application. This cmdlet connects only to sessions that use the specified application." + }, + { + "name": "-Authentication", + "args": [ + { + "name": "System.Management.Automation.Runspaces.AuthenticationMechanism", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "Credssp" + }, + { + "name": "Default" + }, + { + "name": "Digest" + }, + { + "name": "Kerberos" + }, + { + "name": "Negotiate" + }, + { + "name": "NegotiateWithImplicitCredential" + } + ] + } + ], + "description": "Specifies the mechanism that's used to authenticate the user credentials in the command to reconnect to a disconnected session. The acceptable values for this parameter are:" + }, + { + "name": "-CertificateThumbprint", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to connect to the disconnected session. Enter the certificate thumbprint of the certificate." + }, + { + "name": [ + "-ComputerName", + "-Cn" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the computer on which the disconnected session is stored. Sessions are stored on the computer that's at the server-side, or receiving end of a connection. The default is the local computer." + }, + { + "name": "-ConfigurationName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of a session configuration. This cmdlet connects only to sessions that use the specified session configuration." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-ConnectionUri", + "-URI", + "-CU" + ], + "args": [ + { + "name": "System.Uri" + } + ], + "isRequired": true, + "description": "Specifies a URI that defines the connection endpoint that is used to reconnect to the disconnected session." + }, + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to connect to the disconnected session. The default is the current user." + }, + { + "name": "-Id", + "args": [ + { + "name": "System.Int32" + } + ], + "isRequired": true, + "description": "Specifies the ID of a disconnected session. The Id parameter works only when the disconnected session was previously connected to the current session." + }, + { + "name": "-InstanceId", + "args": [ + { + "name": "System.Guid" + } + ], + "isRequired": true, + "description": "Specifies the instance ID of the disconnected session. The instance ID is a GUID that uniquely identifies a PSSession on a local or remote computer. The instance ID is stored in the InstanceId property of the PSSession." + }, + { + "name": "-JobName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a friendly name for the job that `Receive-PSSession` returns." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the friendly name of the disconnected session." + }, + { + "name": "-OutTarget", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.OutTarget", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "Host" + }, + { + "name": "Job" + } + ] + } + ], + "description": "Determines how the session results are returned. The acceptable values for this parameter are:" + }, + { + "name": "-Port", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies the remote computer's network port that's used to reconnect to the session. To connect to a remote computer, it must be listening on the port that the connection uses. The default ports are 5985, which is the WinRM port for HTTP, and 5986, which is the WinRM port for HTTPS." + }, + { + "name": "-Session", + "args": [ + { + "name": "System.Management.Automation.Runspaces.PSSession" + } + ], + "isRequired": true, + "description": "Specifies the disconnected session. Enter a variable that contains the PSSession or a command that creates or gets the PSSession, such as a `Get-PSSession` command." + }, + { + "name": "-SessionOption", + "args": [ + { + "name": "System.Management.Automation.Remoting.PSSessionOption" + } + ], + "description": "Specifies advanced options for the session. Enter a SessionOption object, such as one that you create by using the `New-PSSessionOption` cmdlet, or a hash table in which the keys are session option names and the values are session option values." + }, + { + "name": "-UseSSL", + "description": "Indicates that this cmdlet uses the Secure Sockets Layer (SSL) protocol to connect to the disconnected session. By default, SSL isn't used." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ComputerName-Or-ConnectionUri-Or-Id-Or-Session" + } + ], + "description": "Gets results of commands in disconnected sessions", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/register-argumentcompleter.json b/command-signatures/json/autogenerated/powershell/register-argumentcompleter.json index b5840e6f..67d540c8 100644 --- a/command-signatures/json/autogenerated/powershell/register-argumentcompleter.json +++ b/command-signatures/json/autogenerated/powershell/register-argumentcompleter.json @@ -8,11 +8,12 @@ "name": "System.String[]" } ], - "description": "Specifies the name of the commands as an array." + "isRequired": true, + "description": "Specifies the name of one or more commands to register the argument completer for. This parameter is mandatory for native commands." }, { "name": "-Native", - "description": "Indicates that the argument completer is for a native command where PowerShell cannot complete parameter names." + "description": "Indicates that the argument completer is for a native command where PowerShell can't complete parameter names." }, { "name": "-ParameterName", @@ -22,7 +23,7 @@ } ], "isRequired": true, - "description": "Specifies the name of the parameter whose argument is being completed. The parameter name specified cannot be an enumerated value, such as the ForegroundColor parameter of the `Write-Host` cmdlet.\n" + "description": "Specifies the name of the parameter the argument completer applies to. The type for specified parameters can't be an enumeration, such as the ForegroundColor parameter of the `Write-Host` cmdlet." }, { "name": "-ScriptBlock", @@ -32,7 +33,7 @@ } ], "isRequired": true, - "description": "Specifies the commands to run to perform tab completion. The script block you provide should return the values that complete the input. The script block must unroll the values using the pipeline (`ForEach-Object`, `Where-Object`, etc.), or another suitable method. Returning an array of values causes PowerShell to treat the entire array as one tab completion value.\n" + "description": "Specifies the commands to run to perform tab completion. The scriptblock you provide should return the values that complete the input. The scriptblock must unroll the values using the pipeline (`ForEach-Object`, `Where-Object`, etc.), or another suitable method. Returning an array of values causes PowerShell to treat the entire array as one tab completion value." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/register-cimindicationevent.json b/command-signatures/json/autogenerated/powershell/register-cimindicationevent.json new file mode 100644 index 00000000..9234e6de --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/register-cimindicationevent.json @@ -0,0 +1,306 @@ +{ + "name": "Register-CimIndicationEvent", + "options": [ + { + "name": "-Action", + "args": [ + { + "name": "System.Management.Automation.ScriptBlock" + } + ], + "description": "Specifies the commands that handle the events. The commands specified by this parameter run when an event is raised, instead of sending the event to the event queue. Enclose the commands in braces (`{}`) to create a scriptblock." + }, + { + "name": "-CimSession", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimSession" + } + ], + "isRequired": true, + "description": "Runs the command using the specified CIM session. Enter a variable that contains the CIM session, or a command that creates or gets the CIM session, such as the `New-CimSession` or `Get-CimSession` cmdlets. For more information, see [about_CimSession](../Microsoft.PowerShell.Core/About/about_CimSession.md)." + }, + { + "name": "-ClassName", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the indication class to which you are subscribing. You can use tab completion to browse the list of classes, because PowerShell gets a list of classes from the local WMI server to provide a list of class names." + }, + { + "name": [ + "-ComputerName", + "-CN", + "-ServerName" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the computer on which you want to run the CIM operation. You can specify a fully qualified domain name (FQDN), a NetBIOS name, or an IP address." + }, + { + "name": "-Forward", + "description": "Indicates that events for the subscription are forwarded to the session on the local computer. Use this parameter when you are registering for events on a remote computer or in a remote session." + }, + { + "name": "-MaxTriggerCount", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Parameter to indicate that the subscriber should be auto-unregistered after being triggered for specified times. If the value is equal or less than zero, there is no limit on the number of times the event can be triggered without being unregistered." + }, + { + "name": "-MessageData", + "args": [ + { + "name": "System.Management.Automation.PSObject" + } + ], + "description": "Specifies any additional data to associate with this event subscription. The value of this parameter appears in the MessageData property of all the events associated with this subscription." + }, + { + "name": "-Namespace", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the namespace for the CIM operation. The default namespace is root/CIMV2. You can use tab completion to browse the list of namespaces, because PowerShell gets a list of namespaces from the local WMI server to provide the list of namespaces." + }, + { + "name": [ + "-OperationTimeoutSec", + "-OT" + ], + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "Specifies the amount of time that the cmdlet waits for a response from the computer. By default, the value of this parameter is 0, which means that the cmdlet uses the default timeout value for the server." + }, + { + "name": "-Query", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies a query to run on the CIM server. If the value specified contains double quotes `\"`, single quotes `'`, or a backslash `\\`, you must escape those characters by prefixing them with the backslash character. If the value specified uses the WQL LIKE operator, then you must escape the following characters by enclosing them in square brackets `[]`: percent `%`, underscore `_`, or opening square bracket `[`." + }, + { + "name": "-QueryDialect", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the query language used for the Query parameter. The acceptable values for this parameter are: WQL or CQL. The default value is WQL." + }, + { + "name": "-SourceIdentifier", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a name for the subscription. The name that you specify must be unique in the current session. The default value is a GUID that PowerShell assigns. This value appears in the value of the SourceIdentifier property of the subscriber object and of all event objects associated with this subscription." + }, + { + "name": "-SupportEvent", + "description": "Indicates that the event subscription is hidden. Use this parameter when the current subscription is part of a more complex event registration mechanism and it should not be discovered independently." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ClassName-Or-Query" + }, + { + "name": "-Action-Or-SourceIdentifier" + } + ], + "description": "Subscribes to indications using a filter expression or a query expression.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/register-engineevent.json b/command-signatures/json/autogenerated/powershell/register-engineevent.json index a23e2747..ae161a90 100644 --- a/command-signatures/json/autogenerated/powershell/register-engineevent.json +++ b/command-signatures/json/autogenerated/powershell/register-engineevent.json @@ -8,7 +8,7 @@ "name": "System.Management.Automation.ScriptBlock" } ], - "description": "Specifies commands to handle the events. The commands in the Action run when an event is raised, instead of sending the event to the event queue. Enclose the commands in braces (`{}`) to create a script block.\n" + "description": "Specifies commands to handle the events. The commands in the Action run when an event is raised, instead of sending the event to the event queue. Enclose the commands in braces (`{}`) to create a scriptblock." }, { "name": "-Forward", @@ -30,7 +30,7 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies additional data associated with the event. The value of this parameter appears in the MessageData property of the event object." + "description": "This parameter is part of the base class for all Event cmdlets. The `Register-EngineEvent` doesn't use this parameter. Any data passed to this parameter is ignored." }, { "name": "-SourceIdentifier", @@ -40,11 +40,11 @@ } ], "isRequired": true, - "description": "Specifies the source identifier of the event to which you are subscribing. The source identifier must be unique in the current session. This parameter is required.\n" + "description": "Specifies the source identifier of the event to which you are subscribing. The source identifier must be unique in the current session. This parameter is required." }, { "name": "-SupportEvent", - "description": "Indicates that the cmdlet hides the event subscription. Add this parameter when the current subscription is part of a more complex event registration mechanism and it should not be discovered independently.\n" + "description": "Indicates that the cmdlet hides the event subscription. Add this parameter when the current subscription is part of a more complex event registration mechanism and it should not be discovered independently." }, { "name": [ @@ -220,11 +220,11 @@ "args": [ { "name": "-SourceIdentifier", - "description": "Specifies the source identifier of the event to which you are subscribing. The source identifier must be unique in the current session. This parameter is required.\n" + "description": "Specifies the source identifier of the event to which you are subscribing. The source identifier must be unique in the current session. This parameter is required." }, { "name": "-Action", - "description": "Specifies commands to handle the events. The commands in the Action run when an event is raised, instead of sending the event to the event queue. Enclose the commands in braces (`{}`) to create a script block.\n" + "description": "Specifies commands to handle the events. The commands in the Action run when an event is raised, instead of sending the event to the event queue. Enclose the commands in braces (`{}`) to create a scriptblock." } ], "description": "Subscribes to events that are generated by the PowerShell engine and by the `New-Event` cmdlet.", diff --git a/command-signatures/json/autogenerated/powershell/register-objectevent.json b/command-signatures/json/autogenerated/powershell/register-objectevent.json index 99905226..0b0cb0e7 100644 --- a/command-signatures/json/autogenerated/powershell/register-objectevent.json +++ b/command-signatures/json/autogenerated/powershell/register-objectevent.json @@ -8,7 +8,7 @@ "name": "System.Management.Automation.ScriptBlock" } ], - "description": "Specifies the commands to handle the event. The commands in the Action run when an event is raised, instead of sending the event to the event queue. Enclose the commands in braces ( { } ) to create a script block.\n" + "description": "Specifies the commands to handle the event. The commands in the Action run when an event is raised, instead of sending the event to the event queue. Enclose the commands in braces (`{}`) to create a scriptblock." }, { "name": "-EventName", @@ -18,7 +18,7 @@ } ], "isRequired": true, - "description": "Specifies the event to which you are subscribing.\n" + "description": "Specifies the event to which you are subscribing." }, { "name": "-Forward", @@ -59,11 +59,11 @@ "name": "System.String" } ], - "description": "Specifies a name that you select for the subscription. The name that you select must be unique in the current session. The default value is the GUID that PowerShell assigns.\n" + "description": "Specifies a name that you select for the subscription. The name that you select must be unique in the current session. The default value is the GUID that PowerShell assigns." }, { "name": "-SupportEvent", - "description": "Indicates that the cmdlet hides the event subscription. Use this parameter when the current subscription is part of a more complex event registration mechanism and should not be discovered independently.\n" + "description": "Indicates that the cmdlet hides the event subscription. Use this parameter when the current subscription is part of a more complex event registration mechanism and should not be discovered independently." }, { "name": [ @@ -243,15 +243,15 @@ }, { "name": "-EventName", - "description": "Specifies the event to which you are subscribing.\n" + "description": "Specifies the event to which you are subscribing." }, { "name": "-SourceIdentifier", - "description": "Specifies a name that you select for the subscription. The name that you select must be unique in the current session. The default value is the GUID that PowerShell assigns.\n" + "description": "Specifies a name that you select for the subscription. The name that you select must be unique in the current session. The default value is the GUID that PowerShell assigns." }, { "name": "-Action", - "description": "Specifies the commands to handle the event. The commands in the Action run when an event is raised, instead of sending the event to the event queue. Enclose the commands in braces ( { } ) to create a script block.\n" + "description": "Specifies the commands to handle the event. The commands in the Action run when an event is raised, instead of sending the event to the event queue. Enclose the commands in braces (`{}`) to create a scriptblock." } ], "description": "Subscribes to the events that are generated by a Microsoft .NET Framework object.", diff --git a/command-signatures/json/autogenerated/powershell/register-psresourcerepository.json b/command-signatures/json/autogenerated/powershell/register-psresourcerepository.json index a1467ef0..5d4b98a3 100644 --- a/command-signatures/json/autogenerated/powershell/register-psresourcerepository.json +++ b/command-signatures/json/autogenerated/powershell/register-psresourcerepository.json @@ -1,6 +1,42 @@ { "name": "Register-PSResourceRepository", "options": [ + { + "name": "-ApiVersion", + "args": [ + { + "name": "Microsoft.PowerShell.PSResourceGet.UtilClasses.PSRepositoryInfo+APIVersion", + "suggestions": [ + { + "name": "ContainerRegistry" + }, + { + "name": "Local" + }, + { + "name": "NugetServer" + }, + { + "name": "Unknown" + }, + { + "name": "V2" + }, + { + "name": "V3" + } + ] + } + ], + "description": "Specifies the API version used by the repository. Valid values are:" + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-CredentialInfo", "args": [ @@ -10,6 +46,15 @@ ], "description": "A PSCredentialInfo object that includes the name of a vault and a secret that's stored in a Microsoft.PowerShell.SecretManagement store." }, + { + "name": "-CredentialProvider", + "args": [ + { + "name": "Microsoft.PowerShell.PSResourceGet.UtilClasses.CredentialProviderType" + } + ], + "description": "This is a dynamic parameter that specifies the credential provider to use for the repository. This parameter is only available when the repository being registered is an Azure Artifacts feed. Valid values are:" + }, { "name": "-Force", "description": "Overwrites a repository if it already exists." @@ -32,11 +77,10 @@ "name": "-Priority", "args": [ { - "name": "System.Int32", - "default": "50" + "name": "System.Int32" } ], - "description": "Specifies the priority ranking of the repository. Valid priority values range from 0 to 100. Lower values have a higher priority ranking. The default value is `50`.\n" + "description": "Specifies the priority ranking of the repository. Valid priority values range from 0 to 100. Lower values have a higher priority ranking. The default value is `50`." }, { "name": "-PSGallery", @@ -51,7 +95,7 @@ } ], "isRequired": true, - "description": "Specifies an array of hashtables that contain repository information. Use this parameter to register multiple repositories at once. Each hashtable can only have keys associated with parameters for the NameParameterSet or the PSGalleryParameterSet ." + "description": "Specifies an array of hashtables that contain repository information. Use this parameter to register multiple repositories at once. Each hashtable can only have keys associated with parameters for the NameParameterSet or the PSGalleryParameterSet." }, { "name": "-Trusted", @@ -65,14 +109,7 @@ } ], "isRequired": true, - "description": "Specifies the location of the repository to be registered. The value must use one of the following URI schemas:\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the location of the repository to be registered. The value must use one of the following URI schemas:" }, { "name": [ @@ -259,7 +296,7 @@ }, { "name": "-Uri", - "description": "Specifies the location of the repository to be registered. The value must use one of the following URI schemas:\n" + "description": "Specifies the location of the repository to be registered. The value must use one of the following URI schemas:" } ], "description": "Registers a repository for PowerShell resources.", diff --git a/command-signatures/json/autogenerated/powershell/register-pssessionconfiguration.json b/command-signatures/json/autogenerated/powershell/register-pssessionconfiguration.json new file mode 100644 index 00000000..b0e66a81 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/register-pssessionconfiguration.json @@ -0,0 +1,441 @@ +{ + "name": "Register-PSSessionConfiguration", + "options": [ + { + "name": "-AccessMode", + "args": [ + { + "name": "System.Management.Automation.Runspaces.PSSessionConfigurationAccessMode", + "suggestions": [ + { + "name": "Disabled" + }, + { + "name": "Local" + }, + { + "name": "Remote" + } + ] + } + ], + "description": "Enables and disables the session configuration and determines whether it can be used for remote or local sessions on the computer. The acceptable values for this parameter are:" + }, + { + "name": "-ApplicationBase", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the path of the assembly file (`*.dll`) that's specified in the value of the AssemblyName parameter. Use this parameter when the value of the AssemblyName parameter doesn't include a path. The default is the current directory." + }, + { + "name": "-AssemblyName", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of an assembly file (\\*.dll) in which the configuration type is defined. You can specify the path of the .dll in this parameter or in the value of the ApplicationBase parameter." + }, + { + "name": "-ConfigurationTypeName", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the fully qualified name of the Microsoft .NET Framework type that's used for this configuration. The type that you specify must implement the System.Management.Automation.Remoting.PSSessionConfiguration class." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "Suppresses all user prompts and restarts the WinRM service without prompting. Restarting the service makes the configuration change effective." + }, + { + "name": "-MaximumReceivedDataSizePerCommandMB", + "args": [ + { + "name": "System.Nullable`1[System.Double]" + } + ], + "description": "Specifies a limit for the amount of data that can be sent to this computer in any single remote command. Enter the data size in megabytes (MB). The default is 50 MB." + }, + { + "name": "-MaximumReceivedObjectSizeMB", + "args": [ + { + "name": "System.Nullable`1[System.Double]" + } + ], + "description": "Specifies a limit for the amount of data that can be sent to this computer in any single object. Enter the data size in megabytes. The default is 10 MB." + }, + { + "name": "-ModulesToImport", + "args": [ + { + "name": "System.Object[]" + } + ], + "description": "Specifies the modules that are automatically imported into sessions that use the session configuration." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies a name for the session configuration. This parameter is required." + }, + { + "name": "-NoServiceRestart", + "description": "Doesn't restart the WinRM service, and suppresses the prompt to restart the service." + }, + { + "name": "-Path", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the path and filename of a session configuration file (.pssc), such as one created by `New-PSSessionConfigurationFile`. If you omit the path, the default is the current directory." + }, + { + "name": [ + "-ProcessorArchitecture", + "-PA" + ], + "args": [ + { + "name": "System.String", + "suggestions": [ + { + "name": "amd64" + }, + { + "name": "x86" + } + ] + } + ], + "description": "Determines whether a 32-bit or 64-bit version of the PowerShell process is started in sessions that use this session configuration. The acceptable values for this parameter are: x86 (32-bit) and AMD64 (64-bit). The default value is determined by the processor architecture of the computer that hosts the session configuration." + }, + { + "name": [ + "-PSVersion", + "-PowerShellVersion" + ], + "args": [ + { + "name": "System.Version" + } + ], + "description": "Specifies the version of PowerShell in sessions that use this session configuration." + }, + { + "name": "-RunAsCredential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies credentials for commands in the session. By default, commands run with the permissions of the current user." + }, + { + "name": "-SecurityDescriptorSddl", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a Security Descriptor Definition Language (SDDL) string for the configuration." + }, + { + "name": "-SessionTypeOption", + "args": [ + { + "name": "System.Management.Automation.PSSessionTypeOption" + } + ], + "description": "Specifies type-specific options for the session configuration. Enter a session type options object, such as the PSWorkflowExecutionOption object that the `New-PSWorkflowExecutionOption` cmdlet returns." + }, + { + "name": "-ShowSecurityDescriptorUI", + "description": "Indicates that this cmdlet displays a property sheet that helps you create the SDDL for the session configuration. The property sheet appears after you enter the `Register-PSSessionConfiguration` command and then restart the WinRM service." + }, + { + "name": "-StartupScript", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the fully qualified path of a PowerShell script. The specified script runs in the new session that uses the session configuration." + }, + { + "name": "-ThreadApartmentState", + "args": [ + { + "name": "System.Threading.ApartmentState", + "suggestions": [ + { + "name": "MTA" + }, + { + "name": "STA" + }, + { + "name": "Unknown" + } + ] + } + ], + "description": "Specifies the apartment state of the threading module to be used. Acceptable values are:" + }, + { + "name": "-ThreadOptions", + "args": [ + { + "name": "System.Management.Automation.Runspaces.PSThreadOptions", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "ReuseThread" + }, + { + "name": "UseCurrentThread" + }, + { + "name": "UseNewThread" + } + ] + } + ], + "description": "Specifies how threads are created and used when a command runs in the session. The acceptable values for this parameter are:" + }, + { + "name": "-TransportOption", + "args": [ + { + "name": "System.Management.Automation.PSTransportOption" + } + ], + "description": "Specifies the transport option." + }, + { + "name": "-UseSharedProcess", + "description": "Use only one process to host all sessions that are started by the same user and use the same session configuration. By default, each session is hosted in its own process." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies a name for the session configuration. This parameter is required." + }, + { + "name": "-AssemblyName", + "description": "Specifies the name of an assembly file (\\*.dll) in which the configuration type is defined. You can specify the path of the .dll in this parameter or in the value of the ApplicationBase parameter." + }, + { + "name": "-ConfigurationTypeName", + "description": "Specifies the fully qualified name of the Microsoft .NET Framework type that's used for this configuration. The type that you specify must implement the System.Management.Automation.Remoting.PSSessionConfiguration class." + } + ], + "description": "Creates and registers a new session configuration.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/register-scheduledjob.json b/command-signatures/json/autogenerated/powershell/register-scheduledjob.json new file mode 100644 index 00000000..54f2bab4 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/register-scheduledjob.json @@ -0,0 +1,182 @@ +{ + "name": "Register-ScheduledJob", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Register-ScheduledJob", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/register-wmievent.json b/command-signatures/json/autogenerated/powershell/register-wmievent.json new file mode 100644 index 00000000..130c88a6 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/register-wmievent.json @@ -0,0 +1,289 @@ +{ + "name": "Register-WmiEvent", + "options": [ + { + "name": "-Action", + "args": [ + { + "name": "scriptblock" + } + ] + }, + { + "name": "-Class", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-ComputerName", + "-Cn" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Credential", + "args": [ + { + "name": "pscredential" + } + ] + }, + { + "name": "-Forward" + }, + { + "name": "-MaxTriggerCount", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-MessageData", + "args": [ + { + "name": "psobject" + } + ] + }, + { + "name": [ + "-Namespace", + "-NS" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Query", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-SourceIdentifier", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-SupportEvent" + }, + { + "name": [ + "-Timeout", + "-TimeoutMSec" + ], + "args": [ + { + "name": "long" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Class-Or-Query" + }, + { + "name": "-SourceIdentifier" + }, + { + "name": "-Action" + } + ], + "description": "Register-WmiEvent [-Class] [[-SourceIdentifier] ] [[-Action] ] [-Namespace ] [-Credential ] [-ComputerName ] [-Timeout ] [-MessageData ] [-SupportEvent] [-Forward] [-MaxTriggerCount ] [] Register-WmiEvent [-Query] [[-SourceIdentifier] ] [[-Action] ] [-Namespace ] [-Credential ] [-ComputerName ] [-Timeout ] [-MessageData ] [-SupportEvent] [-Forward] [-MaxTriggerCount ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-alias.json b/command-signatures/json/autogenerated/powershell/remove-alias.json index 5476b406..3bd737af 100644 --- a/command-signatures/json/autogenerated/powershell/remove-alias.json +++ b/command-signatures/json/autogenerated/powershell/remove-alias.json @@ -3,7 +3,7 @@ "options": [ { "name": "-Force", - "description": "Indicates that the cmdlet removes an alias, including aliases with the Option property set to ReadOnly . The Force parameter can't remove an alias with an Option property set to Constant ." + "description": "Indicates that the cmdlet removes an alias, including aliases with the Option property set to ReadOnly. The Force parameter can't remove an alias with an Option property set to Constant." }, { "name": "-Name", @@ -19,11 +19,10 @@ "name": "-Scope", "args": [ { - "name": "System.String", - "default": "Local" + "name": "System.String" } ], - "description": "Affects only the aliases in the specified scope. The default scope is Local . For more information, see about_Scopes (../microsoft.powershell.core/about/about_scopes.md).\n" + "description": "Affects only the aliases in the specified scope. The default scope is Local. For more information, see [about_Scopes](../microsoft.powershell.core/about/about_scopes.md)." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/remove-appprovisionedsharedpackagecontainer.json b/command-signatures/json/autogenerated/powershell/remove-appprovisionedsharedpackagecontainer.json new file mode 100644 index 00000000..2ca6a728 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-appprovisionedsharedpackagecontainer.json @@ -0,0 +1,264 @@ +{ + "name": "Remove-AppProvisionedSharedPackageContainer", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + }, + { + "name": "Debug" + } + ] + } + ] + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Name", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-Online", + "isRequired": true + }, + { + "name": "-Path", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Remove-AppProvisionedSharedPackageContainer -Name -Path [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] Remove-AppProvisionedSharedPackageContainer -Name -Online [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-appsharedpackagecontainer.json b/command-signatures/json/autogenerated/powershell/remove-appsharedpackagecontainer.json new file mode 100644 index 00000000..5b6d13de --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-appsharedpackagecontainer.json @@ -0,0 +1,198 @@ +{ + "name": "Remove-AppSharedPackageContainer", + "options": [ + { + "name": "-ForceApplicationShutdown" + }, + { + "name": "-Name", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name" + } + ], + "description": "Remove-AppSharedPackageContainer [-Name] [-ForceApplicationShutdown] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-appxpackage.json b/command-signatures/json/autogenerated/powershell/remove-appxpackage.json new file mode 100644 index 00000000..4b406bf5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-appxpackage.json @@ -0,0 +1,225 @@ +{ + "name": "Remove-AppxPackage", + "options": [ + { + "name": "-AllUsers" + }, + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Package", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-PreserveApplicationData" + }, + { + "name": "-PreserveRoamableApplicationData" + }, + { + "name": "-User", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Package" + } + ], + "description": "Remove-AppxPackage [-Package] [-PreserveApplicationData] [-WhatIf] [-Confirm] [] Remove-AppxPackage [-Package] [-PreserveRoamableApplicationData] [-WhatIf] [-Confirm] [] Remove-AppxPackage [-Package] [-AllUsers] [-WhatIf] [-Confirm] [] Remove-AppxPackage [-Package] -User [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-appxpackageautoupdatesettings.json b/command-signatures/json/autogenerated/powershell/remove-appxpackageautoupdatesettings.json new file mode 100644 index 00000000..041c9121 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-appxpackageautoupdatesettings.json @@ -0,0 +1,213 @@ +{ + "name": "Remove-AppxPackageAutoUpdateSettings", + "options": [ + { + "name": "-AllUsers" + }, + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-PackageFamilyName", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-UseSystemPolicySource" + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-PackageFamilyName" + } + ], + "description": "Remove-AppxPackageAutoUpdateSettings [-PackageFamilyName] [-UseSystemPolicySource] [-AllUsers] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-appxprovisionedpackage.json b/command-signatures/json/autogenerated/powershell/remove-appxprovisionedpackage.json new file mode 100644 index 00000000..c31ec713 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-appxprovisionedpackage.json @@ -0,0 +1,276 @@ +{ + "name": "Remove-AppxProvisionedPackage", + "options": [ + { + "name": "-AllUsers", + "description": "Execute the command to all users." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-PackageName", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the name of the app package (.appx) to remove from the Windows image." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Removes an app package (.appx) from a Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-appxvolume.json b/command-signatures/json/autogenerated/powershell/remove-appxvolume.json new file mode 100644 index 00000000..c7cb9d6a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-appxvolume.json @@ -0,0 +1,207 @@ +{ + "name": "Remove-AppxVolume", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Volume", + "args": [ + { + "name": "AppxVolume[]" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Remove-AppxVolume [-Volume] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-bcdelement.json b/command-signatures/json/autogenerated/powershell/remove-bcdelement.json new file mode 100644 index 00000000..b0b23b4f --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-bcdelement.json @@ -0,0 +1,253 @@ +{ + "name": "Remove-BcdElement", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Element", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Element Description }}" + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Element", + "description": "{{ Fill Element Description }}" + }, + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-bcdentry.json b/command-signatures/json/autogenerated/powershell/remove-bcdentry.json new file mode 100644 index 00000000..099e733c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-bcdentry.json @@ -0,0 +1,240 @@ +{ + "name": "Remove-BcdEntry", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-bitstransfer.json b/command-signatures/json/autogenerated/powershell/remove-bitstransfer.json new file mode 100644 index 00000000..79d4f6de --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-bitstransfer.json @@ -0,0 +1,214 @@ +{ + "name": "Remove-BitsTransfer", + "options": [ + { + "name": [ + "-BitsJob", + "-b" + ], + "args": [ + { + "name": "BitsJob[]" + } + ], + "isRequired": true, + "description": "Specifies an array of BITS transfer jobs to cancel. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as the Get-BitsTransfer cmdlet." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-BitsJob", + "description": "Specifies an array of BITS transfer jobs to cancel. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as the Get-BitsTransfer cmdlet." + } + ], + "description": "Cancels a BITS transfer job.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-certificateenrollmentpolicyserver.json b/command-signatures/json/autogenerated/powershell/remove-certificateenrollmentpolicyserver.json new file mode 100644 index 00000000..faad3ac7 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-certificateenrollmentpolicyserver.json @@ -0,0 +1,229 @@ +{ + "name": "Remove-CertificateEnrollmentPolicyServer", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Url", + "args": [ + { + "name": "System.Uri" + } + ], + "isRequired": true, + "description": "Specifies the URL of the enrollment policy server to remove from the local configuration." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": "-Context", + "args": [ + { + "name": "Context", + "suggestions": [ + { + "name": "Machine" + }, + { + "name": "User" + } + ] + } + ], + "isRequired": true, + "description": "Specifies that information about the location of an enrollment policy server should be removed from either the `User` or computer (`Machine`) context." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Url", + "description": "Specifies the URL of the enrollment policy server to remove from the local configuration." + } + ], + "description": "Removes an enrollment policy server and the URL of the enrollment policy server from the current user or local computer configuration.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-certificatenotificationtask.json b/command-signatures/json/autogenerated/powershell/remove-certificatenotificationtask.json new file mode 100644 index 00000000..6d258974 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-certificatenotificationtask.json @@ -0,0 +1,211 @@ +{ + "name": "Remove-CertificateNotificationTask", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Identifies the notification task to be deleted." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Identifies the notification task to be deleted." + } + ], + "description": "Removes a certificate notification task from Task Scheduler.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-ciminstance.json b/command-signatures/json/autogenerated/powershell/remove-ciminstance.json new file mode 100644 index 00000000..395ed203 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-ciminstance.json @@ -0,0 +1,289 @@ +{ + "name": "Remove-CimInstance", + "options": [ + { + "name": "-CimSession", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimSession[]" + } + ], + "isRequired": true, + "description": "Runs the command using the specified CIM session. Enter a variable that contains the CIM session, or a command that creates or gets the CIM session, such as the `New-CimSession` or `Get-CimSession` cmdlets. For more information, see [about_CimSession](../Microsoft.PowerShell.Core/About/about_CimSession.md)." + }, + { + "name": [ + "-ComputerName", + "-CN", + "-ServerName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the name of the computer on which you want to run the CIM operation. You can specify a fully qualified domain name (FQDN) or a NetBIOS name." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-InputObject", + "-CimInstance" + ], + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimInstance" + } + ], + "isRequired": true, + "description": "Specifies a CIM instance object to be removed from the CIM server. The object passed to the cmdlet is not changed, only the instance in the CIM server is removed." + }, + { + "name": "-Namespace", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the namespace for the CIM operation. The default namespace is root/CIMV2. You can use tab completion to browse the list of namespaces, because PowerShell gets a list of namespaces from the local WMI server to provide the list of namespaces." + }, + { + "name": [ + "-OperationTimeoutSec", + "-OT" + ], + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "Specifies the amount of time that the cmdlet waits for a response from the computer. By default, the value of this parameter is `0`, which means that the cmdlet uses the default timeout value for the server." + }, + { + "name": "-Query", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies a query to run on the CIM server. You can specify the query dialect using the QueryDialect parameter." + }, + { + "name": "-QueryDialect", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the query language used for the Query parameter. The acceptable values for this parameter are: `WQL` or `CQL`. The default value is `WQL`." + }, + { + "name": "-ResourceUri", + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the resource uniform resource identifier (URI) of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Query" + }, + { + "name": "-Namespace", + "description": "Specifies the namespace for the CIM operation. The default namespace is root/CIMV2. You can use tab completion to browse the list of namespaces, because PowerShell gets a list of namespaces from the local WMI server to provide the list of namespaces." + } + ], + "description": "Removes a CIM instance from a computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-cimsession.json b/command-signatures/json/autogenerated/powershell/remove-cimsession.json new file mode 100644 index 00000000..89f37b72 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-cimsession.json @@ -0,0 +1,254 @@ +{ + "name": "Remove-CimSession", + "options": [ + { + "name": "-CimSession", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimSession[]" + } + ], + "isRequired": true, + "description": "Specifies the session objects of the CIM sessions to close." + }, + { + "name": [ + "-ComputerName", + "-CN", + "-ServerName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies an array of names of computers. Removes the sessions that connect to the specified computers. You can specify a fully qualified domain name (FQDN) or a NetBIOS name." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Id", + "args": [ + { + "name": "System.UInt32[]" + } + ], + "isRequired": true, + "description": "Specifies the ID of the CIM session to remove. Specify one or more IDs separated by commas, or use the range operator (`..`) to specify a range of IDs. An Id is an integer that uniquely identifies the CIM session in the current PowerShell session." + }, + { + "name": "-InstanceId", + "args": [ + { + "name": "System.Guid[]" + } + ], + "isRequired": true, + "description": "Specifies the instance ID of the CIM session to remove. InstanceId is a Globally Unique Identifier (GUID) that uniquely identifies a CIM session. The InstanceId is unique, even when you have multiple sessions running in PowerShell." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the friendly name of the CIM session to remove. You can use wildcard characters with this parameter." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-CimSession-Or-ComputerName-Or-Id" + } + ], + "description": "Removes one or more CIM sessions.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-computer.json b/command-signatures/json/autogenerated/powershell/remove-computer.json new file mode 100644 index 00000000..22da2a9b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-computer.json @@ -0,0 +1,239 @@ +{ + "name": "Remove-Computer", + "options": [ + { + "name": "-ComputerName", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Force" + }, + { + "name": "-LocalCredential", + "args": [ + { + "name": "pscredential" + } + ] + }, + { + "name": "-PassThru" + }, + { + "name": "-Restart" + }, + { + "name": [ + "-UnjoinDomainCredential", + "-Credential" + ], + "args": [ + { + "name": "pscredential" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": "-WorkgroupName", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Remove-Computer [[-UnjoinDomainCredential] ] [-Restart] [-Force] [-PassThru] [-WorkgroupName ] [-WhatIf] [-Confirm] [] Remove-Computer -UnjoinDomainCredential [-LocalCredential ] [-Restart] [-ComputerName ] [-Force] [-PassThru] [-WorkgroupName ] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-event.json b/command-signatures/json/autogenerated/powershell/remove-event.json index 56782478..cd30287d 100644 --- a/command-signatures/json/autogenerated/powershell/remove-event.json +++ b/command-signatures/json/autogenerated/powershell/remove-event.json @@ -1,6 +1,13 @@ { "name": "Remove-Event", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-EventIdentifier", "args": [ @@ -21,13 +28,6 @@ "isRequired": true, "description": "Specifies the source identifier for which this cmdlet deletes events from. Wildcards are not permitted. An EventIdentifier or SourceIdentifier parameter is required in every command." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/remove-eventlog.json b/command-signatures/json/autogenerated/powershell/remove-eventlog.json new file mode 100644 index 00000000..2c7975ce --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-eventlog.json @@ -0,0 +1,235 @@ +{ + "name": "Remove-EventLog", + "options": [ + { + "name": [ + "-ComputerName", + "-CN" + ], + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": [ + "-LogName", + "-LN" + ], + "args": [ + { + "name": "string[]" + } + ], + "isRequired": true + }, + { + "name": [ + "-Source", + "-SRC" + ], + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-LogName" + }, + { + "name": "-ComputerName" + } + ], + "description": "Remove-EventLog [-LogName] [[-ComputerName] ] [-WhatIf] [-Confirm] [] Remove-EventLog [[-ComputerName] ] [-Source ] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-item.json b/command-signatures/json/autogenerated/powershell/remove-item.json index bcaa2434..3105fae1 100644 --- a/command-signatures/json/autogenerated/powershell/remove-item.json +++ b/command-signatures/json/autogenerated/powershell/remove-item.json @@ -1,18 +1,25 @@ { "name": "Remove-Item", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet. For more information, see the following articles:" + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter isn't supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-DeleteKey", - "description": "This is a dynamic parameter made available by the Certificate provider. The Certificate provider and this parameter are only available on Windows platforms.\n" + "description": "This is a dynamic parameter made available by the Certificate provider. The Certificate provider and this parameter are only available on Windows platforms." }, { "name": "-Exclude", @@ -21,7 +28,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory.\n" + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -30,11 +37,11 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they're retrieved." }, { "name": "-Force", - "description": "Forces the cmdlet to remove items that can't otherwise be changed, such as hidden or read-only files or read-only aliases or variables. The cmdlet can't remove constant aliases or variables. Implementation varies from provider to provider. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md). Even using the Force parameter, the cmdlet can't override security restrictions." + "description": "Forces the cmdlet to remove items that can't otherwise be changed, such as hidden or read-only files or read-only aliases or variables. The cmdlet can't remove constant aliases or variables. Implementation varies from provider to provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md). Even using the Force parameter, the cmdlet can't override security restrictions." }, { "name": "-Include", @@ -43,7 +50,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -57,7 +64,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Path", @@ -71,7 +78,7 @@ }, { "name": "-Recurse", - "description": "Indicates that this cmdlet deletes the items in the specified locations and in all child items of the locations.\n" + "description": "Indicates that this cmdlet deletes the items in the specified locations and in all child items of the locations." }, { "name": "-Stream", @@ -80,14 +87,7 @@ "name": "System.String[]" } ], - "description": "This is a dynamic parameter made available by the FileSystem provider. This parameter is only available on Windows. This parameter can't be used in combination with the Recurse parameter.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet. For more information, see the following articles:\n" + "description": "This is a dynamic parameter made available by the FileSystem provider. This parameter is only available on Windows. This parameter can't be used in combination with the Recurse parameter." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/remove-itemproperty.json b/command-signatures/json/autogenerated/powershell/remove-itemproperty.json index f9f72b6f..433eb8f7 100644 --- a/command-signatures/json/autogenerated/powershell/remove-itemproperty.json +++ b/command-signatures/json/autogenerated/powershell/remove-itemproperty.json @@ -1,14 +1,21 @@ { "name": "Remove-ItemProperty", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Exclude", @@ -17,7 +24,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -26,11 +33,11 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Force", - "description": "Forces the cmdlet to remove a property of an object that cannot otherwise be accessed by the user. Implementation varies from provider to provider. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md)." + "description": "Forces the cmdlet to remove a property of an object that cannot otherwise be accessed by the user. Implementation varies from provider to provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md)." }, { "name": "-Include", @@ -39,7 +46,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -53,7 +60,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": [ @@ -78,13 +85,6 @@ "isRequired": true, "description": "Specifies the path of the item whose properties are being removed. Wildcard characters are permitted." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/remove-job.json b/command-signatures/json/autogenerated/powershell/remove-job.json index fbcb4d6d..7eace5c4 100644 --- a/command-signatures/json/autogenerated/powershell/remove-job.json +++ b/command-signatures/json/autogenerated/powershell/remove-job.json @@ -10,6 +10,13 @@ ], "description": "Deletes jobs that include the specified words in the command. You can enter a comma-separated array." }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before `Remove-Job` is run." + }, { "name": "-Filter", "args": [ @@ -18,14 +25,14 @@ } ], "isRequired": true, - "description": "Deletes jobs that satisfy all the conditions established in the associated hash table. Enter a hash table where the keys are job properties and the values are job property values.\n" + "description": "Deletes jobs that satisfy all the conditions established in the associated hash table. Enter a hash table where the keys are job properties and the values are job property values." }, { "name": [ "-Force", "-F" ], - "description": "Deletes a job even if the job's state is Running . If the Force parameter isn't specified, `Remove-Job` doesn't delete running jobs." + "description": "Deletes a job even if the job's state is Running. If the Force parameter isn't specified, `Remove-Job` doesn't delete running jobs." }, { "name": "-Id", @@ -35,7 +42,7 @@ } ], "isRequired": true, - "description": "Deletes background jobs with the specified Id . You can enter a comma-separated array. The job's Id is a unique integer that identifies a job within the current session.\n" + "description": "Deletes background jobs with the specified Id. You can enter a comma-separated array. The job's Id is a unique integer that identifies a job within the current session." }, { "name": "-InstanceId", @@ -45,7 +52,7 @@ } ], "isRequired": true, - "description": "Deletes jobs with the specified InstanceId . You can enter a comma-separated array. An InstanceId is a unique GUID that identifies a job.\n" + "description": "Deletes jobs with the specified InstanceId. You can enter a comma-separated array. An InstanceId is a unique GUID that identifies a job." }, { "name": "-Job", @@ -55,7 +62,7 @@ } ], "isRequired": true, - "description": "Specifies the jobs to be deleted. Enter a variable that contains the jobs or a command that gets the jobs. You can enter a comma-separated array.\n" + "description": "Specifies the jobs to be deleted. Enter a variable that contains the jobs or a command that gets the jobs. You can enter a comma-separated array." }, { "name": "-Name", @@ -65,7 +72,7 @@ } ], "isRequired": true, - "description": "Only deletes jobs with the specified friendly name. Wildcards are permitted. You can enter a comma-separated array.\n" + "description": "Only deletes jobs with the specified friendly name. Wildcards are permitted. You can enter a comma-separated array." }, { "name": "-State", @@ -110,14 +117,7 @@ } ], "isRequired": true, - "description": "Only deletes jobs with the specified state. To delete jobs with a state of Running , use the Force parameter.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before `Remove-Job` is run." + "description": "Only deletes jobs with the specified state. To delete jobs with a state of Running, use the Force parameter." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/remove-jobtrigger.json b/command-signatures/json/autogenerated/powershell/remove-jobtrigger.json new file mode 100644 index 00000000..300d940a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-jobtrigger.json @@ -0,0 +1,182 @@ +{ + "name": "Remove-JobTrigger", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Remove-JobTrigger", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-localgroup.json b/command-signatures/json/autogenerated/powershell/remove-localgroup.json new file mode 100644 index 00000000..9db11cdd --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-localgroup.json @@ -0,0 +1,230 @@ +{ + "name": "Remove-LocalGroup", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.LocalGroup[]" + } + ], + "isRequired": true, + "description": "Specifies an array of security groups that this cmdlet deletes. To obtain groups, use the `Get-LocalGroup` cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies an array of names of the security groups that this cmdlet deletes." + }, + { + "name": "-SID", + "args": [ + { + "name": "System.Security.Principal.SecurityIdentifier[]" + } + ], + "isRequired": true, + "description": "Specifies an array of security IDs (SIDs) of security groups that this cmdlet deletes." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name-Or-SID" + } + ], + "description": "Deletes local security groups.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-localgroupmember.json b/command-signatures/json/autogenerated/powershell/remove-localgroupmember.json new file mode 100644 index 00000000..a690bd3d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-localgroupmember.json @@ -0,0 +1,244 @@ +{ + "name": "Remove-LocalGroupMember", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Group", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.LocalGroup" + } + ], + "isRequired": true, + "description": "Specifies the security group from which this cmdlet removes members." + }, + { + "name": "-Member", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.LocalPrincipal[]" + } + ], + "isRequired": true, + "description": "Specifies an array of users or groups that this cmdlet removes from a security group. You can specify users or groups by name, security ID (SID), or LocalPrincipal objects. Specify SID strings in S-R-I-S-S . . . format." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the security group from which this cmdlet removes members." + }, + { + "name": "-SID", + "args": [ + { + "name": "System.Security.Principal.SecurityIdentifier" + } + ], + "isRequired": true, + "description": "Specifies the security ID of the security group from which this cmdlet removes members." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Group-Or-Name-Or-SID" + }, + { + "name": "-Member", + "description": "Specifies an array of users or groups that this cmdlet removes from a security group. You can specify users or groups by name, security ID (SID), or LocalPrincipal objects. Specify SID strings in S-R-I-S-S . . . format." + } + ], + "description": "Removes members from a local group.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-localuser.json b/command-signatures/json/autogenerated/powershell/remove-localuser.json new file mode 100644 index 00000000..52c445c5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-localuser.json @@ -0,0 +1,230 @@ +{ + "name": "Remove-LocalUser", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.LocalUser[]" + } + ], + "isRequired": true, + "description": "Specifies an array of user accounts that this cmdlet deletes. To obtain a user account, use the `Get-LocalUser` cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies an array of names of the user accounts that this cmdlet deletes." + }, + { + "name": "-SID", + "args": [ + { + "name": "System.Security.Principal.SecurityIdentifier[]" + } + ], + "isRequired": true, + "description": "Specifies an array of security IDs (SIDs) of user accounts that this cmdlet deletes." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name-Or-SID" + } + ], + "description": "Deletes local user accounts.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-module.json b/command-signatures/json/autogenerated/powershell/remove-module.json index eaf4e079..1fc011d9 100644 --- a/command-signatures/json/autogenerated/powershell/remove-module.json +++ b/command-signatures/json/autogenerated/powershell/remove-module.json @@ -1,9 +1,16 @@ { "name": "Remove-Module", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Force", - "description": "Indicates that this cmdlet removes read-only modules. By default, `Remove-Module` removes only read-write modules.\n" + "description": "Indicates that this cmdlet removes read-only modules. By default, `Remove-Module` removes only read-write modules." }, { "name": "-FullyQualifiedName", @@ -13,7 +20,7 @@ } ], "isRequired": true, - "description": "The value can be a module name, a full module specification, or a path to a module file.\n" + "description": "The value can be a module name, a full module specification, or a path to a module file." }, { "name": "-ModuleInfo", @@ -35,13 +42,6 @@ "isRequired": true, "description": "Specifies the names of modules to remove. Wildcard characters are permitted. You can also pipe name strings to `Remove-Module`." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/remove-osconfigurationdocument.json b/command-signatures/json/autogenerated/powershell/remove-osconfigurationdocument.json new file mode 100644 index 00000000..82fb4507 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-osconfigurationdocument.json @@ -0,0 +1,246 @@ +{ + "name": "Remove-OsConfigurationDocument", + "options": [ + { + "name": [ + "-FriendlyName", + "-FNAME" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill FriendlyName Description }}" + }, + { + "name": "-Id", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": [ + "-SourceId", + "-SID" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill SourceId Description }}" + }, + { + "name": "-TimeoutInSeconds", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "{{ Fill TimeoutInSeconds Description }}" + }, + { + "name": "-Wait", + "description": "{{ Fill Wait Description }}" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Id", + "description": "{{ Fill Id Description }}" + }, + { + "name": "-SourceId", + "description": "{{ Fill SourceId Description }}" + }, + { + "name": "-FriendlyName", + "description": "{{ Fill FriendlyName Description }}" + }, + { + "name": "-TimeoutInSeconds", + "description": "{{ Fill TimeoutInSeconds Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-osconfigurationscenariodefinition.json b/command-signatures/json/autogenerated/powershell/remove-osconfigurationscenariodefinition.json new file mode 100644 index 00000000..1b78a615 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-osconfigurationscenariodefinition.json @@ -0,0 +1,219 @@ +{ + "name": "Remove-OsConfigurationScenarioDefinition", + "options": [ + { + "name": "-Name", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-SchemaVersion", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-Version", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name" + }, + { + "name": "-Version" + }, + { + "name": "-SchemaVersion" + } + ], + "description": "Remove-OsConfigurationScenarioDefinition [-Name] [-Version] [-SchemaVersion] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-pmemdedicatedmemory.json b/command-signatures/json/autogenerated/powershell/remove-pmemdedicatedmemory.json new file mode 100644 index 00000000..cc388537 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-pmemdedicatedmemory.json @@ -0,0 +1,206 @@ +{ + "name": "Remove-PmemDedicatedMemory", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-DeviceNumber", + "args": [ + { + "name": "uint32" + } + ], + "isRequired": true + }, + { + "name": "-Force" + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Remove-PmemDedicatedMemory -DeviceNumber [-Force] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-pmemdisk.json b/command-signatures/json/autogenerated/powershell/remove-pmemdisk.json new file mode 100644 index 00000000..2549ffc8 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-pmemdisk.json @@ -0,0 +1,210 @@ +{ + "name": "Remove-PmemDisk", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-DiskNumber", + "args": [ + { + "name": "uint32" + } + ], + "isRequired": true + }, + { + "name": "-Force" + }, + { + "name": "-Simulated", + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Remove-PmemDisk -DiskNumber [-Force] [-WhatIf] [-Confirm] [] Remove-PmemDisk -Simulated [-Force] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-psbreakpoint.json b/command-signatures/json/autogenerated/powershell/remove-psbreakpoint.json index 667b7357..95576b5b 100644 --- a/command-signatures/json/autogenerated/powershell/remove-psbreakpoint.json +++ b/command-signatures/json/autogenerated/powershell/remove-psbreakpoint.json @@ -11,6 +11,13 @@ "isRequired": true, "description": "Specifies the breakpoints to delete. Enter a variable that contains breakpoint objects or a command that gets breakpoint objects, such as a `Get-PSBreakpoint` command. You can also pipe breakpoint objects to `Remove-PSBreakpoint`." }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Id", "args": [ @@ -31,14 +38,7 @@ "name": "Runspace" } ], - "description": "Specifies the Id of a Runspace object so you can interact with breakpoints in the specified runspace.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the Id of a Runspace object so you can interact with breakpoints in the specified runspace." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/remove-psdrive.json b/command-signatures/json/autogenerated/powershell/remove-psdrive.json index 71883d00..9205fba6 100644 --- a/command-signatures/json/autogenerated/powershell/remove-psdrive.json +++ b/command-signatures/json/autogenerated/powershell/remove-psdrive.json @@ -1,6 +1,13 @@ { "name": "Remove-PSDrive", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Force", "description": "Removes the current PowerShell drive." @@ -13,7 +20,7 @@ } ], "isRequired": true, - "description": "Specifies the name of the drive.\n" + "description": "Specifies the name of the drive." }, { "name": "-Name", @@ -38,18 +45,10 @@ "name": "-Scope", "args": [ { - "name": "System.String", - "default": "Local" + "name": "System.String" } ], - "description": "Specifies a scope for the drive. The acceptable values for this parameter are: `Global`, `Local`, and `Script`, or a number relative to the current scope. Scopes number `0` through the number of scopes. The current scope number is `0` and its parent is `1`. For more information, see about_Scopes (../Microsoft.PowerShell.Core/About/about_Scopes.md)." - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies a scope for the drive. The acceptable values for this parameter are: `Global`, `Local`, and `Script`, or a number relative to the current scope. Scopes number `0` through the number of scopes. The current scope number is `0` and its parent is `1`. For more information, see [about_Scopes](../Microsoft.PowerShell.Core/About/about_Scopes.md)." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/remove-psreadlinekeyhandler.json b/command-signatures/json/autogenerated/powershell/remove-psreadlinekeyhandler.json index 60d10bf1..eb5efd98 100644 --- a/command-signatures/json/autogenerated/powershell/remove-psreadlinekeyhandler.json +++ b/command-signatures/json/autogenerated/powershell/remove-psreadlinekeyhandler.json @@ -8,17 +8,16 @@ ], "args": [ { - "name": "System.String[]" + "name": "string[]" } ], - "isRequired": true, - "description": "Specifies an array of keys or sequences of keys to be removed. A single binding is specified by using a single string. If the binding is a sequence of keys, separate the keys by a comma, as in the following example:\n" + "isRequired": true }, { "name": "-ViMode", "args": [ { - "name": "Microsoft.PowerShell.ViMode", + "name": "ViMode", "suggestions": [ { "name": "Insert" @@ -28,8 +27,7 @@ } ] } - ], - "description": "Specify which vi mode the binding applies to. Possible values are: Insert, Command." + ] }, { "name": [ @@ -204,11 +202,10 @@ ], "args": [ { - "name": "-Chord", - "description": "Specifies an array of keys or sequences of keys to be removed. A single binding is specified by using a single string. If the binding is a sequence of keys, separate the keys by a comma, as in the following example:\n" + "name": "-Chord" } ], - "description": "Removes a key binding.", + "description": "Remove-PSReadLineKeyHandler [-Chord] [-ViMode ] []", "parserDirectives": { "flagsArePosixNoncompliant": true, "flagsMatchUniquePrefix": true, diff --git a/command-signatures/json/autogenerated/powershell/remove-pssession.json b/command-signatures/json/autogenerated/powershell/remove-pssession.json index 6c63ca5e..87df5bb1 100644 --- a/command-signatures/json/autogenerated/powershell/remove-pssession.json +++ b/command-signatures/json/autogenerated/powershell/remove-pssession.json @@ -12,7 +12,14 @@ } ], "isRequired": true, - "description": "Specifies an array of names of computers. This cmdlet closes the PSSessions that are connected to the specified computers. Wildcard characters are permitted.\n" + "description": "Specifies an array of names of computers. This cmdlet closes the PSSessions that are connected to the specified computers. Wildcard characters are permitted." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-ContainerId", @@ -22,7 +29,7 @@ } ], "isRequired": true, - "description": "Specifies an array of IDs of containers. This cmdlet removes sessions for each of the specified containers. Use the `docker ps` command to get a list of container IDs. For more information, see the help for the docker ps (https://docs.docker.com/engine/reference/commandline/ps/)command." + "description": "Specifies an array of IDs of containers. This cmdlet removes sessions for each of the specified containers. Use the `docker ps` command to get a list of container IDs. For more information, see the help for the [docker ps](https://docs.docker.com/engine/reference/commandline/ps/) command." }, { "name": "-Id", @@ -32,7 +39,7 @@ } ], "isRequired": true, - "description": "Specifies an array of IDs of sessions. This cmdlet closes the PSSessions with the specified IDs. Type one or more IDs, separated by commas, or use the range operator (`..`) to specify a range of IDs.\n" + "description": "Specifies an array of IDs of sessions. This cmdlet closes the PSSessions with the specified IDs. Type one or more IDs, separated by commas, or use the range operator (`..`) to specify a range of IDs." }, { "name": "-InstanceId", @@ -42,7 +49,7 @@ } ], "isRequired": true, - "description": "Specifies an array of instance IDs. This cmdlet closes the PSSessions that have the specified instance IDs.\n" + "description": "Specifies an array of instance IDs. This cmdlet closes the PSSessions that have the specified instance IDs." }, { "name": "-Name", @@ -52,7 +59,7 @@ } ], "isRequired": true, - "description": "Specifies an array of friendly names of sessions. This cmdlet closes the PSSessions that have the specified friendly names. Wildcard characters are permitted.\n" + "description": "Specifies an array of friendly names of sessions. This cmdlet closes the PSSessions that have the specified friendly names. Wildcard characters are permitted." }, { "name": "-Session", @@ -62,7 +69,7 @@ } ], "isRequired": true, - "description": "Specifies the session objects of the PSSessions to close. Enter a variable that contains the PSSessions or a command that creates or gets the PSSessions , such as a `New-PSSession` or `Get-PSSession` command. You can also pipe one or more session objects to `Remove-PSSession`." + "description": "Specifies the session objects of the PSSessions to close. Enter a variable that contains the PSSessions or a command that creates or gets the PSSessions, such as a `New-PSSession` or `Get-PSSession` command. You can also pipe one or more session objects to `Remove-PSSession`." }, { "name": [ @@ -75,7 +82,7 @@ } ], "isRequired": true, - "description": "Specifies an array of ID of virtual machines. This cmdlet starts an interactive session with each of the specified virtual machines. To see the virtual machines that are available to you, use the following command:\n" + "description": "Specifies an array of ID of virtual machines. This cmdlet starts an interactive session with each of the specified virtual machines. To see the virtual machines that are available to you, use the following command:" }, { "name": "-VMName", @@ -87,13 +94,6 @@ "isRequired": true, "description": "Specifies an array of names of virtual machines. This cmdlet starts an interactive session with each of the specified virtual machines. To see the virtual machines that are available to you, use the `Get-VM` cmdlet." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/remove-service.json b/command-signatures/json/autogenerated/powershell/remove-service.json new file mode 100644 index 00000000..792ef0b0 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-service.json @@ -0,0 +1,224 @@ +{ + "name": "Remove-Service", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "System.ServiceProcess.ServiceController" + } + ], + "description": "Specifies ServiceController objects that represent the services to remove. Enter a variable that contains the objects, or type a command or expression that gets the objects." + }, + { + "name": [ + "-Name", + "-ServiceName", + "-SN" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the service names of the services to remove. Wildcard characters are permitted." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the service names of the services to remove. Wildcard characters are permitted." + } + ], + "description": "Removes a Windows service.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-typedata.json b/command-signatures/json/autogenerated/powershell/remove-typedata.json index 9859e937..fd973a70 100644 --- a/command-signatures/json/autogenerated/powershell/remove-typedata.json +++ b/command-signatures/json/autogenerated/powershell/remove-typedata.json @@ -1,6 +1,13 @@ { "name": "Remove-TypeData", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Path", "args": [ @@ -9,7 +16,7 @@ } ], "isRequired": true, - "description": "Specifies an array of files that this cmdlet deletes from the session extended type data. This parameter is required.\n" + "description": "Specifies an array of files that this cmdlet deletes from the session extended type data. This parameter is required." }, { "name": "-TypeData", @@ -19,7 +26,7 @@ } ], "isRequired": true, - "description": "Specifies the type data that this cmdlet deletes from the session. This parameter is required. Enter a variable that contains TypeData objects ( System.Management.Automation.Runspaces.TypeData ) or a command that gets TypeData objects, such as a `Get-TypeData` command. You can also pipe TypeData objects to `Remove-TypeData`." + "description": "Specifies the type data that this cmdlet deletes from the session. This parameter is required. Enter a variable that contains TypeData objects (System.Management.Automation.Runspaces.TypeData) or a command that gets TypeData objects, such as a `Get-TypeData` command. You can also pipe TypeData objects to `Remove-TypeData`." }, { "name": "-TypeName", @@ -29,14 +36,7 @@ } ], "isRequired": true, - "description": "Specifies the types that this cmdlet deletes all extended type data for. For types in the System namespace, enter the short name. Otherwise, the full type name is required. Wildcards are not supported.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the types that this cmdlet deletes all extended type data for. For types in the System namespace, enter the short name. Otherwise, the full type name is required. Wildcards are not supported." }, { "name": [ @@ -219,7 +219,7 @@ "args": [ { "name": "-TypeName", - "description": "Specifies the types that this cmdlet deletes all extended type data for. For types in the System namespace, enter the short name. Otherwise, the full type name is required. Wildcards are not supported.\n" + "description": "Specifies the types that this cmdlet deletes all extended type data for. For types in the System namespace, enter the short name. Otherwise, the full type name is required. Wildcards are not supported." } ], "description": "Deletes extended types from the current session.", diff --git a/command-signatures/json/autogenerated/powershell/remove-variable.json b/command-signatures/json/autogenerated/powershell/remove-variable.json index 2d4421d1..90b70408 100644 --- a/command-signatures/json/autogenerated/powershell/remove-variable.json +++ b/command-signatures/json/autogenerated/powershell/remove-variable.json @@ -1,6 +1,13 @@ { "name": "Remove-Variable", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Exclude", "args": [ @@ -32,7 +39,7 @@ } ], "isRequired": true, - "description": "Specifies the name of the variable to be removed. The parameter name ( Name ) is optional. Wildcards are permitted" + "description": "Specifies the name of the variable to be removed. The parameter name (Name) is optional. Wildcards are permitted" }, { "name": "-Scope", @@ -41,14 +48,7 @@ "name": "System.String" } ], - "description": "Gets only the variables in the specified scope. The acceptable values for this parameter are:\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Gets only the variables in the specified scope. The acceptable values for this parameter are:" }, { "name": [ @@ -231,7 +231,7 @@ "args": [ { "name": "-Name", - "description": "Specifies the name of the variable to be removed. The parameter name ( Name ) is optional. Wildcards are permitted", + "description": "Specifies the name of the variable to be removed. The parameter name (Name) is optional. Wildcards are permitted", "generatorName": "get_variable_names" } ], diff --git a/command-signatures/json/autogenerated/powershell/remove-windowscapability.json b/command-signatures/json/autogenerated/powershell/remove-windowscapability.json new file mode 100644 index 00000000..ecde3f84 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-windowscapability.json @@ -0,0 +1,272 @@ +{ + "name": "Remove-WindowsCapability", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Name", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the identity of the capability to remove from an operating system image." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Indicates that the cmdlet operates on a running operating system on the local host." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Uninstalls a Windows capability package from an image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-windowsdriver.json b/command-signatures/json/autogenerated/powershell/remove-windowsdriver.json new file mode 100644 index 00000000..483a1dd9 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-windowsdriver.json @@ -0,0 +1,267 @@ +{ + "name": "Remove-WindowsDriver", + "options": [ + { + "name": "-Driver", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the .inf file or folder containing the .inf files of the drivers you want to add. When third-party drivers are added to an image, they are named OEM0.inf, OEM1.inf, and so on. You must specify the published name (for example, OEM1.inf) to remove the driver. You cannot remove default drivers." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Removes a driver from an offline Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-windowsimage.json b/command-signatures/json/autogenerated/powershell/remove-windowsimage.json new file mode 100644 index 00000000..4d49c764 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-windowsimage.json @@ -0,0 +1,263 @@ +{ + "name": "Remove-WindowsImage", + "options": [ + { + "name": "-CheckIntegrity", + "description": "Detects and tracks .wim file corruption when used with the Add-WindowsImage, Dismount-WindowsImage, or Save-WindowsImage cmdlet. CheckIntegrity stops the operation if DISM detects that the .wim file is corrupted when used with the Expand-WindowsImage or Mount-WindowsImage cmdlet." + }, + { + "name": "-ImagePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location of a WIM file." + }, + { + "name": "-Index", + "args": [ + { + "name": "UInt32" + } + ], + "isRequired": true, + "description": "Specifies the index number of a Windows image in a WIM or VHD file. For a VHD file, the Index must be 1." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Name", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the name of an image in a WIM file." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Deletes the specified volume image from a WIM file that has multiple volume images.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-windowspackage.json b/command-signatures/json/autogenerated/powershell/remove-windowspackage.json new file mode 100644 index 00000000..25d0d981 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-windowspackage.json @@ -0,0 +1,284 @@ +{ + "name": "Remove-WindowsPackage", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-NoRestart", + "description": "Suppresses reboot. If a reboot is not required, this command does nothing. This option will keep the application from prompting for a restart or keep it from restarting automatically." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-PackageName", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of a package in the Windows image." + }, + { + "name": "-PackagePath", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to a .cab file." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Removes a package from a Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-wmiobject.json b/command-signatures/json/autogenerated/powershell/remove-wmiobject.json new file mode 100644 index 00000000..522ddee7 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-wmiobject.json @@ -0,0 +1,344 @@ +{ + "name": "Remove-WmiObject", + "options": [ + { + "name": "-AsJob" + }, + { + "name": "-Authentication", + "args": [ + { + "name": "AuthenticationLevel", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "None" + }, + { + "name": "Connect" + }, + { + "name": "Call" + }, + { + "name": "Packet" + }, + { + "name": "PacketIntegrity" + }, + { + "name": "PacketPrivacy" + }, + { + "name": "Unchanged" + } + ] + } + ] + }, + { + "name": "-Authority", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Class", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-ComputerName", + "-Cn" + ], + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Credential", + "args": [ + { + "name": "pscredential" + } + ] + }, + { + "name": "-EnableAllPrivileges" + }, + { + "name": "-Impersonation", + "args": [ + { + "name": "ImpersonationLevel", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "Anonymous" + }, + { + "name": "Identify" + }, + { + "name": "Impersonate" + }, + { + "name": "Delegate" + } + ] + } + ] + }, + { + "name": "-InputObject", + "args": [ + { + "name": "wmi" + } + ], + "isRequired": true + }, + { + "name": "-Locale", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Namespace", + "-NS" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Path", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-ThrottleLimit", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Class" + } + ], + "description": "Remove-WmiObject [-Class] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] [] Remove-WmiObject -InputObject [-AsJob] [-ThrottleLimit ] [-WhatIf] [-Confirm] [] Remove-WmiObject -Path [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] [] Remove-WmiObject [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] [] Remove-WmiObject [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] [] Remove-WmiObject [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/remove-wsmaninstance.json b/command-signatures/json/autogenerated/powershell/remove-wsmaninstance.json new file mode 100644 index 00000000..967886f0 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/remove-wsmaninstance.json @@ -0,0 +1,345 @@ +{ + "name": "Remove-WSManInstance", + "options": [ + { + "name": "-ApplicationName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the application name in the connection. The default value of the ApplicationName parameter is WSMAN. The complete identifier for the remote endpoint is in the following format:" + }, + { + "name": [ + "-Authentication", + "-auth", + "-am" + ], + "args": [ + { + "name": "Microsoft.WSMan.Management.AuthenticationMechanism", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "ClientCertificate" + }, + { + "name": "Credssp" + }, + { + "name": "Default" + }, + { + "name": "Digest" + }, + { + "name": "Kerberos" + }, + { + "name": "Negotiate" + }, + { + "name": "None" + } + ] + } + ], + "description": "Specifies the authentication mechanism to be used at the server. The acceptable values for this parameter are:" + }, + { + "name": "-CertificateThumbprint", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to perform this action. Enter the certificate thumbprint of the certificate." + }, + { + "name": [ + "-ComputerName", + "-cn" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the computer against which to run the management operation. The value can be a fully qualified domain name, a NetBIOS name, or an IP address. Use the local computer name, use localhost, or use a dot (`.`) to specify the local computer. The local computer is the default. When the remote computer is in a different domain from the user, you must use a fully qualified domain name must be used. You can pipe a value for this parameter to the cmdlet." + }, + { + "name": "-ConnectionURI", + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the connection endpoint. The format of this string is as follows:" + }, + { + "name": [ + "-Credential", + "-cred", + "-c" + ], + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to perform this action. The default is the current user. Type a user name, such as `User01`, `Domain01\\User01`, or `User@Domain.com`. Or, enter a PSCredential object, such as one returned by the `Get-Credential` cmdlet. When you type a user name, this cmdlet prompts you for a password." + }, + { + "name": [ + "-OptionSet", + "-os" + ], + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "description": "Specifies a set of switches to a service to modify or refine the nature of the request. These resemble switches used in command-line shells because they are service specific. Any number of options can be specified." + }, + { + "name": "-Port", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies the port to use when the client connects to the WinRM service. When the transport is HTTP, the default port is 80. When the transport is HTTPS, the default port is 443." + }, + { + "name": [ + "-ResourceURI", + "-ruri" + ], + "args": [ + { + "name": "System.Uri" + } + ], + "isRequired": true, + "description": "Specifies the URI of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": "-SelectorSet", + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "isRequired": true, + "description": "Specifies a set of value pairs that are used to select particular management resource instances. The SelectorSet parameter is used when more than one instance of the resource exists. The value of SelectorSet must be a hash table." + }, + { + "name": [ + "-SessionOption", + "-so" + ], + "args": [ + { + "name": "Microsoft.WSMan.Management.SessionOption" + } + ], + "description": "Specifies extended options for the WS-Management session. Enter a SessionOption object that you create by using the New-WSManSessionOption cmdlet. For more information about the options that are available, type `Get-Help New-WSManSessionOption`." + }, + { + "name": [ + "-UseSSL", + "-ssl" + ], + "description": "Specifies that the Secure Sockets Layer (SSL) protocol is used to establish a connection to the remote computer. By default, SSL is not used." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ResourceURI", + "description": "Specifies the URI of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": "-SelectorSet", + "description": "Specifies a set of value pairs that are used to select particular management resource instances. The SelectorSet parameter is used when more than one instance of the resource exists. The value of SelectorSet must be a hash table." + } + ], + "description": "Deletes a management resource instance.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/rename-computer.json b/command-signatures/json/autogenerated/powershell/rename-computer.json new file mode 100644 index 00000000..f21bb0b3 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/rename-computer.json @@ -0,0 +1,279 @@ +{ + "name": "Rename-Computer", + "options": [ + { + "name": "-ComputerName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Renames the specified remote computer. The default is the local computer." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-DomainCredential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to connect to the domain. Explicit credentials are required to rename a computer that is joined to a domain." + }, + { + "name": "-Force", + "description": "Forces the command to run without asking for user confirmation." + }, + { + "name": "-LocalCredential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to connect to the computer specified by the ComputerName parameter. The default is the current user." + }, + { + "name": "-NewName", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies a new name for the computer. This parameter is required." + }, + { + "name": "-PassThru", + "description": "Returns the results of the command. Otherwise, this cmdlet does not generate any output." + }, + { + "name": "-Restart", + "description": "Indicates that this cmdlet restarts the computer that was renamed. A restart is often required to make the change effective." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": "-WsmanAuthentication", + "args": [ + { + "name": "System.String", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "CredSSP" + }, + { + "name": "Default" + }, + { + "name": "Digest" + }, + { + "name": "Kerberos" + }, + { + "name": "Negotiate" + } + ] + } + ], + "description": "Specifies the mechanism that is used to authenticate the user credentials when this cmdlet uses the WSMan protocol. The acceptable values for this parameter are:" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-NewName", + "description": "Specifies a new name for the computer. This parameter is required." + } + ], + "description": "Renames a computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/rename-item.json b/command-signatures/json/autogenerated/powershell/rename-item.json index 734bb4f2..add55ae8 100644 --- a/command-signatures/json/autogenerated/powershell/rename-item.json +++ b/command-signatures/json/autogenerated/powershell/rename-item.json @@ -1,18 +1,25 @@ { "name": "Rename-Item", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. To impersonate another > user, or elevate your credentials when running this cmdlet, use > [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Force", - "description": "Forces the cmdlet to rename items that can't otherwise be changed, such as hidden or read-only files or read-only aliases or variables. The cmdlet can't change constant aliases or variables. Implementation varies from provider to provider. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md).\n" + "description": "Forces the cmdlet to rename items that can't otherwise be changed, such as hidden or read-only files or read-only aliases or variables. The cmdlet can't change constant aliases or variables. Implementation varies from provider to provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md)." }, { "name": [ @@ -26,7 +33,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-NewName", @@ -36,7 +43,7 @@ } ], "isRequired": true, - "description": "Specifies the new name of the item. Enter only a name, not a path and name. If you enter a path that differs from the path that is specified in the Path parameter, `Rename-Item` generates an error. To rename and move an item, use `Move-Item`.\n" + "description": "Specifies the new name of the item. Enter only a name, not a path and name. If you enter a path that differs from the path that is specified in the Path parameter, `Rename-Item` generates an error. To rename and move an item, use `Move-Item`." }, { "name": "-PassThru", @@ -52,13 +59,6 @@ "isRequired": true, "description": "Specifies the path of the item to rename." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", @@ -244,7 +244,7 @@ }, { "name": "-NewName", - "description": "Specifies the new name of the item. Enter only a name, not a path and name. If you enter a path that differs from the path that is specified in the Path parameter, `Rename-Item` generates an error. To rename and move an item, use `Move-Item`.\n" + "description": "Specifies the new name of the item. Enter only a name, not a path and name. If you enter a path that differs from the path that is specified in the Path parameter, `Rename-Item` generates an error. To rename and move an item, use `Move-Item`." } ], "description": "Renames an item in a PowerShell provider namespace.", diff --git a/command-signatures/json/autogenerated/powershell/rename-itemproperty.json b/command-signatures/json/autogenerated/powershell/rename-itemproperty.json index bbf6e59f..2c309f7b 100644 --- a/command-signatures/json/autogenerated/powershell/rename-itemproperty.json +++ b/command-signatures/json/autogenerated/powershell/rename-itemproperty.json @@ -1,14 +1,21 @@ { "name": "Rename-ItemProperty", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Exclude", @@ -17,7 +24,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -26,11 +33,11 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Force", - "description": "Forces the cmdlet to rename a property of an object that cannot otherwise be accessed by the user. Implementation varies from provider to provider. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md)." + "description": "Forces the cmdlet to rename a property of an object that cannot otherwise be accessed by the user. Implementation varies from provider to provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md)." }, { "name": "-Include", @@ -39,7 +46,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -53,7 +60,7 @@ } ], "isRequired": true, - "description": "Specifies a path to the item. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to the item. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": [ @@ -92,13 +99,6 @@ "isRequired": true, "description": "Specifies a path to the item. Wildcard characters are permitted." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/rename-localgroup.json b/command-signatures/json/autogenerated/powershell/rename-localgroup.json new file mode 100644 index 00000000..d2f26933 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/rename-localgroup.json @@ -0,0 +1,244 @@ +{ + "name": "Rename-LocalGroup", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.LocalGroup" + } + ], + "isRequired": true, + "description": "Specifies the security group that this cmdlet renames. To obtain a security group, use the Get-LocalGroup cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the security group that this cmdlet renames." + }, + { + "name": "-NewName", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies a new name for the security group." + }, + { + "name": "-SID", + "args": [ + { + "name": "System.Security.Principal.SecurityIdentifier" + } + ], + "isRequired": true, + "description": "Specifies the security ID (SID) of a security group that this cmdlet renames." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name-Or-SID" + }, + { + "name": "-NewName", + "description": "Specifies a new name for the security group." + } + ], + "description": "Renames a local security group.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/rename-localuser.json b/command-signatures/json/autogenerated/powershell/rename-localuser.json new file mode 100644 index 00000000..76eebf6e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/rename-localuser.json @@ -0,0 +1,244 @@ +{ + "name": "Rename-LocalUser", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.LocalUser" + } + ], + "isRequired": true, + "description": "Specifies the user account that this cmdlet renames. To obtain a user account, use the Get-LocalUser cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the user account that this cmdlet renames." + }, + { + "name": "-NewName", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies a new name for the user account." + }, + { + "name": "-SID", + "args": [ + { + "name": "System.Security.Principal.SecurityIdentifier" + } + ], + "isRequired": true, + "description": "Specifies the security ID (SID) of a user accounts that this cmdlet renames." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name-Or-SID" + }, + { + "name": "-NewName", + "description": "Specifies a new name for the user account." + } + ], + "description": "Renames a local user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/repair-windowsimage.json b/command-signatures/json/autogenerated/powershell/repair-windowsimage.json new file mode 100644 index 00000000..64b53795 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/repair-windowsimage.json @@ -0,0 +1,303 @@ +{ + "name": "Repair-WindowsImage", + "options": [ + { + "name": "-CheckHealth", + "description": "Checks whether the image has been flagged as corrupted by a failed process and whether the corruption can be repaired." + }, + { + "name": "-Defer", + "description": "Defers cleanup operations until the next automatic maintenance." + }, + { + "name": "-LimitAccess", + "description": "Prevents DISM from contacting Windows Update (WU) when searching for the source files to repair an online image." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-NoRestart", + "description": "Suppresses reboot. If a reboot is not required, this command does nothing. This option will keep the application from prompting for a restart or keep it from restarting automatically." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ResetBase", + "description": "Resets the base of superseded components to further reduce the component store size." + }, + { + "name": "-RestoreHealth", + "description": "Scans the image for component store corruption, and then performs repair operations automatically. This operation will take several minutes." + }, + { + "name": "-ScanHealth", + "description": "Scans the image for component store corruption. This operation will take several minutes." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-Source", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies the location of the files that are required to repair an image. You can specify the Windows directory of a mounted image or a running Windows installation that is shared on the network." + }, + { + "name": "-StartComponentCleanup", + "description": "Cleans up superseded components to reduce the size of the component store." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Repairs a Windows image in a WIM or VHD file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/reset-appsharedpackagecontainer.json b/command-signatures/json/autogenerated/powershell/reset-appsharedpackagecontainer.json new file mode 100644 index 00000000..23940a5d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/reset-appsharedpackagecontainer.json @@ -0,0 +1,210 @@ +{ + "name": "Reset-AppSharedPackageContainer", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Force" + }, + { + "name": "-Name", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name" + } + ], + "description": "Reset-AppSharedPackageContainer [-Name] [-Force] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/reset-appxpackage.json b/command-signatures/json/autogenerated/powershell/reset-appxpackage.json new file mode 100644 index 00000000..d0cf213c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/reset-appxpackage.json @@ -0,0 +1,207 @@ +{ + "name": "Reset-AppxPackage", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Package", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Package" + } + ], + "description": "Reset-AppxPackage [-Package] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/reset-computermachinepassword.json b/command-signatures/json/autogenerated/powershell/reset-computermachinepassword.json new file mode 100644 index 00000000..e663c9bf --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/reset-computermachinepassword.json @@ -0,0 +1,210 @@ +{ + "name": "Reset-ComputerMachinePassword", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Credential", + "args": [ + { + "name": "pscredential" + } + ] + }, + { + "name": "-Server", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Reset-ComputerMachinePassword [-Server ] [-Credential ] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/reset-lapspassword.json b/command-signatures/json/autogenerated/powershell/reset-lapspassword.json new file mode 100644 index 00000000..22700c99 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/reset-lapspassword.json @@ -0,0 +1,182 @@ +{ + "name": "Reset-LapsPassword", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Causes Windows Local Administrator Password Solution (LAPS) to immediately rotate the password for the currently managed local account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/reset-psresourcerepository.json b/command-signatures/json/autogenerated/powershell/reset-psresourcerepository.json new file mode 100644 index 00000000..6c913292 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/reset-psresourcerepository.json @@ -0,0 +1,200 @@ +{ + "name": "Reset-PSResourceRepository", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-PassThru", + "description": "By default, the command does not generate any output. When specified, the command displays the results of the reset operation." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Creates a new default `PSRepositories.xml` file with PSGallery registered.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/resolve-dnsname.json b/command-signatures/json/autogenerated/powershell/resolve-dnsname.json new file mode 100644 index 00000000..5312c2dc --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/resolve-dnsname.json @@ -0,0 +1,497 @@ +{ + "name": "Resolve-DnsName", + "options": [ + { + "name": "-CacheOnly", + "description": "Resolves this query using only the local cache." + }, + { + "name": "-DnsOnly", + "description": "Resolves this query using only the DNS protocol." + }, + { + "name": "-DnssecCd", + "description": "Sets the DNSSEC checking-disabled bit for this query." + }, + { + "name": "-DnssecOk", + "description": "Sets the DNSSEC OK bit for this query." + }, + { + "name": "-LlmnrFallback", + "description": "Allows falling back to the LLMNR protocol when resolving this query with DNS fails." + }, + { + "name": "-LlmnrNetbiosOnly", + "description": "Resolves this query using only the LLMNR or NetBIOS protocols." + }, + { + "name": "-LlmnrOnly", + "description": "Resolves this query using only the LLMNR protocol." + }, + { + "name": "-Name", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the name to be resolved." + }, + { + "name": "-NetbiosFallback", + "description": "Allows fallback to the NetBIOS protocol when resolving this query with DNS fails." + }, + { + "name": "-NoHostsFile", + "description": "Skips the hosts file when resolving this query." + }, + { + "name": "-NoIdn", + "description": "Specifies not to use IDN encoding logic for the query." + }, + { + "name": "-NoRecursion", + "description": "Instructs the server not to use recursion when resolving this query." + }, + { + "name": "-QuickTimeout", + "description": "Uses shorter timeouts for this query." + }, + { + "name": "-Server", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies the IP addresses or host names of the DNS servers to be queried. By default the interface DNS servers are queried if this parameter is not supplied." + }, + { + "name": "-TcpOnly", + "description": "Uses only TCP for this query." + }, + { + "name": "-Type", + "args": [ + { + "name": "RecordType", + "suggestions": [ + { + "name": "A" + }, + { + "name": "A_AAAA" + }, + { + "name": "AAAA" + }, + { + "name": "AFSDB" + }, + { + "name": "ALL" + }, + { + "name": "ANY" + }, + { + "name": "CNAME" + }, + { + "name": "DHCID" + }, + { + "name": "DNAME" + }, + { + "name": "DNSKEY" + }, + { + "name": "DS" + }, + { + "name": "HINFO" + }, + { + "name": "ISDN" + }, + { + "name": "MB" + }, + { + "name": "MD" + }, + { + "name": "MF" + }, + { + "name": "MG" + }, + { + "name": "MINFO" + }, + { + "name": "MR" + }, + { + "name": "MX" + }, + { + "name": "NS" + }, + { + "name": "NSEC" + }, + { + "name": "NSEC3" + }, + { + "name": "NSEC3PARAM" + }, + { + "name": "NULL" + }, + { + "name": "OPT" + }, + { + "name": "PTR" + }, + { + "name": "RP" + }, + { + "name": "RRSIG" + }, + { + "name": "RT" + }, + { + "name": "SOA" + }, + { + "name": "SRV" + }, + { + "name": "TXT" + }, + { + "name": "UNKNOWN" + }, + { + "name": "WINS" + }, + { + "name": "WKS" + }, + { + "name": "X25" + } + ] + } + ], + "description": "Specifies the DNS query type that is to be issued. By default the type is A_AAAA, the A and AAAA types will both be queried. The acceptable values for this parameter are:" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the name to be resolved." + }, + { + "name": "-Type", + "description": "Specifies the DNS query type that is to be issued. By default the type is A_AAAA, the A and AAAA types will both be queried. The acceptable values for this parameter are:", + "suggestions": [ + { + "name": "A" + }, + { + "name": "A_AAAA" + }, + { + "name": "AAAA" + }, + { + "name": "AFSDB" + }, + { + "name": "ALL" + }, + { + "name": "ANY" + }, + { + "name": "CNAME" + }, + { + "name": "DHCID" + }, + { + "name": "DNAME" + }, + { + "name": "DNSKEY" + }, + { + "name": "DS" + }, + { + "name": "HINFO" + }, + { + "name": "ISDN" + }, + { + "name": "MB" + }, + { + "name": "MD" + }, + { + "name": "MF" + }, + { + "name": "MG" + }, + { + "name": "MINFO" + }, + { + "name": "MR" + }, + { + "name": "MX" + }, + { + "name": "NS" + }, + { + "name": "NSEC" + }, + { + "name": "NSEC3" + }, + { + "name": "NSEC3PARAM" + }, + { + "name": "NULL" + }, + { + "name": "OPT" + }, + { + "name": "PTR" + }, + { + "name": "RP" + }, + { + "name": "RRSIG" + }, + { + "name": "RT" + }, + { + "name": "SOA" + }, + { + "name": "SRV" + }, + { + "name": "TXT" + }, + { + "name": "UNKNOWN" + }, + { + "name": "WINS" + }, + { + "name": "WKS" + }, + { + "name": "X25" + } + ] + } + ], + "description": "Performs a DNS name query resolution for the specified name.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/resolve-path.json b/command-signatures/json/autogenerated/powershell/resolve-path.json index 99b76e4f..ca4cf2d8 100644 --- a/command-signatures/json/autogenerated/powershell/resolve-path.json +++ b/command-signatures/json/autogenerated/powershell/resolve-path.json @@ -8,7 +8,11 @@ "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to perform this action. The default is the current user.\n" + "description": "Specifies a user account that has permission to perform this action. The default is the current user." + }, + { + "name": "-Force", + "description": "Allows the cmdlet to get items that otherwise can't be accessed by the user, such as hidden or system files. The Force parameter doesn't override security restrictions. Implementation varies among providers. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md)." }, { "name": [ @@ -38,6 +42,15 @@ "name": "-Relative", "description": "Indicates that this cmdlet returns a relative path." }, + { + "name": "-RelativeBasePath", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a path to resolve the relative path from. When you use this parameter, the cmdlet returns the System.Management.Automation.PathInfo object for the resolved path." + }, { "name": [ "-Debug", diff --git a/command-signatures/json/autogenerated/powershell/restart-computer.json b/command-signatures/json/autogenerated/powershell/restart-computer.json index 41547139..4b56db56 100644 --- a/command-signatures/json/autogenerated/powershell/restart-computer.json +++ b/command-signatures/json/autogenerated/powershell/restart-computer.json @@ -14,17 +14,23 @@ "name": "System.String[]" } ], - "description": "Specifies one computer name or a comma-separated array of computer names. `Restart-Computer` accepts ComputerName objects from the pipeline or variables.\n" + "description": "Specifies one computer name or a comma-separated array of computer names. `Restart-Computer` accepts ComputerName objects from the pipeline or variables." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running `Restart-Computer`." }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to do this action. The default is the current user.\n" + "description": "Specifies a user account that has permission to do this action. The default is the current user." }, { "name": "-Delay", @@ -33,7 +39,7 @@ "name": "System.Int16" } ], - "description": "Specifies the frequency of queries, in seconds. PowerShell queries the service specified by the For parameter to determine whether the service is available after the computer is restarted.\n" + "description": "Specifies the frequency of queries, in seconds. PowerShell queries the service specified by the For parameter to determine whether the service is available after the computer is restarted." }, { "name": "-For", @@ -42,18 +48,18 @@ "name": "Microsoft.PowerShell.Commands.WaitForServiceTypes", "suggestions": [ { - "name": "Wmi" + "name": "PowerShell" }, { "name": "WinRM" }, { - "name": "PowerShell" + "name": "Wmi" } ] } ], - "description": "Specifies the behavior of PowerShell as it waits for the specified service or feature to become available after the computer restarts. This parameter is only valid with the Wait parameter.\n" + "description": "Specifies the behavior of PowerShell as it waits for the specified service or feature to become available after the computer restarts. This parameter is only valid with the Wait parameter." }, { "name": [ @@ -72,11 +78,18 @@ "name": "System.Int32" } ], - "description": "Specifies the duration of the wait, in seconds. When the timeout elapses, `Restart-Computer` returns to the command prompt, even if the computers aren't restarted.\n" + "description": "Specifies the duration of the wait, in seconds. When the timeout elapses, `Restart-Computer` returns to the command prompt, even if the computers aren't restarted." }, { "name": "-Wait", - "description": "`Restart-Computer` suppresses the PowerShell prompt and blocks the pipeline until the computers have restarted. You can use this parameter in a script to restart computers and then continue to process when the restart is finished.\n" + "description": "`Restart-Computer` suppresses the PowerShell prompt and blocks the pipeline until the computers have restarted. You can use this parameter in a script to restart computers and then continue to process when the restart is finished." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the `Restart-Computer` runs. The `Restart-Computer` cmdlet isn't run." }, { "name": "-WsmanAuthentication", @@ -105,21 +118,7 @@ ] } ], - "description": "Specifies the mechanism that is used to authenticate the user credentials. This parameter was introduced in Windows PowerShell 3.0.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running `Restart-Computer`." - }, - { - "name": [ - "-WhatIf", - "-wi" - ], - "description": "Shows what would happen if the `Restart-Computer` runs. The `Restart-Computer` cmdlet isn't run." + "description": "Specifies the mechanism that is used to authenticate the user credentials. This parameter was introduced in Windows PowerShell 3.0." }, { "name": [ @@ -295,11 +294,11 @@ "args": [ { "name": "-ComputerName", - "description": "Specifies one computer name or a comma-separated array of computer names. `Restart-Computer` accepts ComputerName objects from the pipeline or variables.\n" + "description": "Specifies one computer name or a comma-separated array of computer names. `Restart-Computer` accepts ComputerName objects from the pipeline or variables." }, { "name": "-Credential", - "description": "Specifies a user account that has permission to do this action. The default is the current user.\n" + "description": "Specifies a user account that has permission to do this action. The default is the current user." } ], "description": "Restarts the operating system on local and remote computers.", diff --git a/command-signatures/json/autogenerated/powershell/restart-service.json b/command-signatures/json/autogenerated/powershell/restart-service.json new file mode 100644 index 00000000..c0c61804 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/restart-service.json @@ -0,0 +1,259 @@ +{ + "name": "Restart-Service", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-DisplayName", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the display names of the services to restarted. Wildcard characters are permitted." + }, + { + "name": "-Exclude", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies services that this cmdlet omits. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as s*. Wildcard characters are permitted." + }, + { + "name": "-Force", + "description": "Forces the command to run without asking for user confirmation." + }, + { + "name": "-Include", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies services that this cmdlet restarts. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as s*. Wildcard characters are permitted." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "System.ServiceProcess.ServiceController[]" + } + ], + "isRequired": true, + "description": "Specifies ServiceController objects that represent the services to restart. Enter a variable that contains the objects, or type a command or expression that gets the objects." + }, + { + "name": [ + "-Name", + "-ServiceName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the service names of the services to restart." + }, + { + "name": "-PassThru", + "description": "Returns an object that represents the service. By default, this cmdlet does not generate any output." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name" + } + ], + "description": "Stops and then starts one or more services.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/restore-computer.json b/command-signatures/json/autogenerated/powershell/restore-computer.json new file mode 100644 index 00000000..0eb254af --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/restore-computer.json @@ -0,0 +1,212 @@ +{ + "name": "Restore-Computer", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": [ + "-RestorePoint", + "-SequenceNumber", + "-SN", + "-RP" + ], + "args": [ + { + "name": "int" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-RestorePoint" + } + ], + "description": "Restore-Computer [-RestorePoint] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/resume-bitstransfer.json b/command-signatures/json/autogenerated/powershell/resume-bitstransfer.json new file mode 100644 index 00000000..812f7a0d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/resume-bitstransfer.json @@ -0,0 +1,221 @@ +{ + "name": "Resume-BitsTransfer", + "options": [ + { + "name": [ + "-Asynchronous", + "-as" + ], + "description": "Indicates that the cmdlet processes the BITS transfer job in the background. The command prompt reappears immediately after the BITS transfer job is resumed. The returned BitsJob object can be used to monitor status and progress." + }, + { + "name": [ + "-BitsJob", + "-b" + ], + "args": [ + { + "name": "BitsJob[]" + } + ], + "isRequired": true, + "description": "Specifies an array of BITS transfer jobs to resume. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as the Get-BitsTransfer cmdlet." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-BitsJob", + "description": "Specifies an array of BITS transfer jobs to resume. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as the Get-BitsTransfer cmdlet." + } + ], + "description": "Resumes a BITS transfer job.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/resume-refsdedupschedule.json b/command-signatures/json/autogenerated/powershell/resume-refsdedupschedule.json new file mode 100644 index 00000000..14aada43 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/resume-refsdedupschedule.json @@ -0,0 +1,195 @@ +{ + "name": "Resume-ReFSDedupSchedule", + "options": [ + { + "name": "-Volume", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Resume-ReFSDedupSchedule [-Volume] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/resume-service.json b/command-signatures/json/autogenerated/powershell/resume-service.json new file mode 100644 index 00000000..970bf11e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/resume-service.json @@ -0,0 +1,255 @@ +{ + "name": "Resume-Service", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-DisplayName", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the display names of the services to be resumed. Wildcard characters are permitted." + }, + { + "name": "-Exclude", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies services that this cmdlet omits. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as s*. Wildcard characters are permitted." + }, + { + "name": "-Include", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies services to resume. The value of this parameter qualifies Name parameter. Enter a name element or pattern, such as s*. Wildcard characters are permitted." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "System.ServiceProcess.ServiceController[]" + } + ], + "isRequired": true, + "description": "Specifies ServiceController objects that represent the services to resumed. Enter a variable that contains the objects, or type a command or expression that gets the objects." + }, + { + "name": [ + "-Name", + "-ServiceName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the service names of the services to be resumed." + }, + { + "name": "-PassThru", + "description": "Returns an object that represents the service. By default, this cmdlet does not generate any output." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name" + } + ], + "description": "Resumes one or more suspended (paused) services.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/save-help.json b/command-signatures/json/autogenerated/powershell/save-help.json index 6bb9cc65..d77e5ac4 100644 --- a/command-signatures/json/autogenerated/powershell/save-help.json +++ b/command-signatures/json/autogenerated/powershell/save-help.json @@ -8,7 +8,7 @@ "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user credential. This cmdlet runs the command by using credentials of a user who has permission to access the file system location specified by the DestinationPath parameter. This parameter is valid only when the DestinationPath or LiteralPath parameter is used in the command.\n" + "description": "Specifies a user credential. This cmdlet runs the command by using credentials of a user who has permission to access the file system location specified by the DestinationPath parameter. This parameter is valid only when the DestinationPath or LiteralPath parameter is used in the command." }, { "name": [ @@ -21,11 +21,11 @@ } ], "isRequired": true, - "description": "Specifies the path of the folder in which the help files are saved. Do not specify a file name or file name extension." + "description": "Specifies the path of the folder in which the help files are saved. Don't specify a filename or filename extension." }, { "name": "-Force", - "description": "Indicates that this cmdlet does not follow the once-per-day limitation, skips version checking, and downloads files that exceed the 1 GB limit.\n" + "description": "Indicates that this cmdlet doesn't follow the once-per-day limitation, skips version checking, and downloads files that exceed the 1 GB limit." }, { "name": "-FullyQualifiedModule", @@ -34,7 +34,7 @@ "name": "Microsoft.PowerShell.Commands.ModuleSpecification[]" } ], - "description": "The value can be a module name, a full module specification, or a path to a module file.\n" + "description": "The value can be a module name, a full module specification, or a path to a module file." }, { "name": [ @@ -48,7 +48,7 @@ } ], "isRequired": true, - "description": "Specifies a path of the destination folder. Unlike the value of the DestinationPath parameter, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + "description": "Specifies a path of the destination folder. Unlike the value of the DestinationPath parameter, the value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": [ @@ -60,13 +60,21 @@ "name": "System.Management.Automation.PSModuleInfo[]" } ], - "description": "Specifies modules for which this cmdlet downloads help. Enter one or more module names or name patters in a comma-separated list or in a file that has one module name on each line. Wildcard characters are permitted. You can also pipe module objects from the `Get-Module` cmdlet to `Save-Help`.\n" + "description": "Specifies modules for which this cmdlet downloads help. Enter one or more module names or name patterns in a comma-separated list or in a file that has one module name on each line. Wildcard characters are permitted. You can also pipe module objects from the `Get-Module` cmdlet to `Save-Help`." }, { "name": "-Scope", "args": [ { - "name": "Microsoft.PowerShell.Commands.UpdateHelpScope" + "name": "Microsoft.PowerShell.Commands.UpdateHelpScope", + "suggestions": [ + { + "name": "AllUsers" + }, + { + "name": "CurrentUser" + } + ] } ], "description": "This parameter does nothing in this cmdlet." @@ -75,15 +83,14 @@ "name": "-UICulture", "args": [ { - "name": "System.Globalization.CultureInfo[]", - "default": "Current UI culture" + "name": "System.Globalization.CultureInfo[]" } ], - "description": "Specifies UI culture values for which this cmdlet gets updated help files. Enter one or more language codes, such as `es-ES`, a variable that contains culture objects, or a command that gets culture objects, such as a `Get-Culture` or `Get-UICulture` command.\n" + "description": "Specifies UI culture values for which this cmdlet gets updated help files. Enter one or more language codes, such as `es-ES`, a variable that contains culture objects, or a command that gets culture objects, such as a `Get-Culture` or `Get-UICulture` command. Wildcard characters aren't permitted." }, { "name": "-UseDefaultCredentials", - "description": "Indicates that this cmdlet runs the command, including the web download, with the credentials of the current user. By default, the command runs without explicit credentials.\n" + "description": "Indicates that this cmdlet runs the command, including the web download, with the credentials of the current user. By default, the command runs without explicit credentials." }, { "name": [ @@ -259,15 +266,15 @@ "args": [ { "name": "-DestinationPath", - "description": "Specifies the path of the folder in which the help files are saved. Do not specify a file name or file name extension." + "description": "Specifies the path of the folder in which the help files are saved. Don't specify a filename or filename extension." }, { "name": "-Module", - "description": "Specifies modules for which this cmdlet downloads help. Enter one or more module names or name patters in a comma-separated list or in a file that has one module name on each line. Wildcard characters are permitted. You can also pipe module objects from the `Get-Module` cmdlet to `Save-Help`.\n" + "description": "Specifies modules for which this cmdlet downloads help. Enter one or more module names or name patterns in a comma-separated list or in a file that has one module name on each line. Wildcard characters are permitted. You can also pipe module objects from the `Get-Module` cmdlet to `Save-Help`." }, { "name": "-UICulture", - "description": "Specifies UI culture values for which this cmdlet gets updated help files. Enter one or more language codes, such as `es-ES`, a variable that contains culture objects, or a command that gets culture objects, such as a `Get-Culture` or `Get-UICulture` command.\n" + "description": "Specifies UI culture values for which this cmdlet gets updated help files. Enter one or more language codes, such as `es-ES`, a variable that contains culture objects, or a command that gets culture objects, such as a `Get-Culture` or `Get-UICulture` command. Wildcard characters aren't permitted." } ], "description": "Downloads and saves the newest help files to a file system directory.", diff --git a/command-signatures/json/autogenerated/powershell/save-osimage.json b/command-signatures/json/autogenerated/powershell/save-osimage.json new file mode 100644 index 00000000..a9fb27f2 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/save-osimage.json @@ -0,0 +1,244 @@ +{ + "name": "Save-OsImage", + "options": [ + { + "name": "-CapturePath", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-ImagePath", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + }, + { + "name": "Debug" + } + ] + } + ] + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Save-OsImage -ImagePath -CapturePath [-LogPath ] [-ScratchDirectory ] [-LogLevel ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/save-psresource.json b/command-signatures/json/autogenerated/powershell/save-psresource.json index 695bdb5e..d8ec71b3 100644 --- a/command-signatures/json/autogenerated/powershell/save-psresource.json +++ b/command-signatures/json/autogenerated/powershell/save-psresource.json @@ -1,6 +1,10 @@ { "name": "Save-PSResource", "options": [ + { + "name": "-AcceptLicense", + "description": "For modules that require a license, automatically accepts the license agreement during installation." + }, { "name": "-AsNupkg", "description": "Saves the resource as a `.nupkg` file." @@ -9,6 +13,13 @@ "name": "-AuthenticodeCheck", "description": "Validates the resource's signed files and catalog files on Windows." }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ @@ -53,8 +64,7 @@ "name": "-Path", "args": [ { - "name": "System.String", - "default": "current directory" + "name": "System.String" } ], "description": "Specifies the path to save the resource to. If no path is provided, the resource is saved in the current directory." @@ -66,6 +76,10 @@ ], "description": "When specified, includes prerelease versions in search results returned." }, + { + "name": "-Quiet", + "description": "Suppresses the progress bar output." + }, { "name": "-Repository", "args": [ @@ -73,7 +87,7 @@ "name": "System.String[]" } ], - "description": "Specifies one or more repository names to search. If not specified, search includes all registered repositories, in priority order (highest first), until a repository is found that contains the package. Repositories are sorted by priority then by name. Lower Priority values have a higher precedence.\n" + "description": "Specifies one or more repository names to search. If not specified, search includes all registered repositories, in priority order (highest first), until a repository is found that contains the package. Repositories are sorted by priority then by name. Lower Priority values have a higher precedence." }, { "name": "-SkipDependencyCheck", @@ -99,14 +113,7 @@ "name": "System.String" } ], - "description": "Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/save-softwareinventory.json b/command-signatures/json/autogenerated/powershell/save-softwareinventory.json new file mode 100644 index 00000000..a7c4cf7f --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/save-softwareinventory.json @@ -0,0 +1,297 @@ +{ + "name": "Save-SoftwareInventory", + "options": [ + { + "name": "-CSRConfigFile", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-DevicesInf", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + }, + { + "name": "Debug" + } + ] + } + ] + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Online", + "isRequired": true + }, + { + "name": "-OutputDirectory", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-PartitioningScript", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-Path", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-ResetConfigXml", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Save-SoftwareInventory -PartitioningScript -ResetConfigXml -Path [-DevicesInf ] [-OutputDirectory ] [-CSRConfigFile ] [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] Save-SoftwareInventory -PartitioningScript -ResetConfigXml -Online [-DevicesInf ] [-OutputDirectory ] [-CSRConfigFile ] [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/save-windowsimage.json b/command-signatures/json/autogenerated/powershell/save-windowsimage.json new file mode 100644 index 00000000..4d41f59c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/save-windowsimage.json @@ -0,0 +1,251 @@ +{ + "name": "Save-WindowsImage", + "options": [ + { + "name": "-Append", + "description": "Indicates that this cmdlet specifies the location of an existing .wim file to add the Windows image to when you save it." + }, + { + "name": "-CheckIntegrity", + "description": "Indicates that this cmdlet detects and tracks .wim file corruption. *CheckIntegrity* stops the operation if DISM detects that the .wim file is corrupted when used with the Mount-WindowsImage cmdlet. The *CheckIntegrity* parameter does not apply to virtual hard disk (VHD) files." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you want to save." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SupportEa", + "description": "Captures extended attributes." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Applies changes made to a mounted image to its WIM or VHD file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/select-object.json b/command-signatures/json/autogenerated/powershell/select-object.json index f71e7525..8563dfbd 100644 --- a/command-signatures/json/autogenerated/powershell/select-object.json +++ b/command-signatures/json/autogenerated/powershell/select-object.json @@ -1,6 +1,10 @@ { "name": "Select-Object", "options": [ + { + "name": "-CaseInsensitive", + "description": "By default, when you use the Unique parameter the cmdlet uses case-sensitive comparisons. When you use this parameter, the cmdlet uses case-insensitive comparisons." + }, { "name": "-ExcludeProperty", "args": [ @@ -8,7 +12,7 @@ "name": "System.String[]" } ], - "description": "Specifies the properties that this cmdlet excludes from the operation. Wildcards are permitted.\n" + "description": "Specifies the properties that this cmdlet excludes from the operation. Wildcards are permitted." }, { "name": "-ExpandProperty", @@ -17,7 +21,7 @@ "name": "System.String" } ], - "description": "Specifies a property to select, and indicates that an attempt should be made to expand that property. If the input object pipeline doesn't have the property named, `Select-Object` returns an error.\n" + "description": "Specifies a property to select, and indicates that an attempt should be made to expand that property. If the input object pipeline doesn't have the property named, `Select-Object` returns an error. This parameter supports wildcards. However, the wildcard character must resolve to a single property name. If the wildcard character resolves to more than one property name, `Select-Object` returns an error." }, { "name": "-First", @@ -44,7 +48,7 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies objects to send to the cmdlet through the pipeline. This parameter enables you to pipe objects to `Select-Object`.\n" + "description": "Specifies objects to send to the cmdlet through the pipeline. This parameter enables you to pipe objects to `Select-Object`." }, { "name": "-Last", @@ -62,7 +66,7 @@ "name": "System.Object[]" } ], - "description": "Specifies the properties to select. These properties are added as NoteProperty members to the output objects. Wildcards are permitted. If the input object doesn't have the property named, the value of the new NoteProperty is set to `$null`.\n" + "description": "Specifies the properties to select. These properties are added as NoteProperty members to the output objects. Wildcards are permitted. If the input object doesn't have the property named, the value of the new NoteProperty is set to `$null`." }, { "name": "-Skip", @@ -71,7 +75,7 @@ "name": "System.Int32" } ], - "description": "Skips (doesn't select) the specified number of items. By default, the Skip parameter counts from the beginning of the collection of objects. If the command uses the Last parameter, it counts from the end of the collection.\n" + "description": "Skips (doesn't select) the specified number of items. By default, the Skip parameter counts from the beginning of the collection of objects. If the command uses the Last parameter, it counts from the end of the collection." }, { "name": "-SkipIndex", @@ -80,7 +84,7 @@ "name": "System.Int32[]" } ], - "description": "Skips (doesn't select) the objects from an array based on their index values. Enter the indexes in a comma-separated list. Indexes in an array begin with 0, where 0 represents the first value and (n-1) represents the last value.\n" + "description": "Skips (doesn't select) the objects from an array based on their index values. Enter the indexes in a comma-separated list. Indexes in an array begin with 0, where 0 represents the first value and (n-1) represents the last value." }, { "name": "-SkipLast", @@ -89,15 +93,15 @@ "name": "System.Int32" } ], - "description": "Skips (doesn't select) the specified number of items from the end of the list or array. Works in the same way as using Skip together with Last parameter.\n" + "description": "Skips (doesn't select) the specified number of items from the end of the list or array. Works in the same way as using Skip together with Last parameter." }, { "name": "-Unique", - "description": "Specifies that if a subset of the input objects has identical properties and values, only a single member of the subset should be selected. Unique selects values after other filtering parameters are applied.\n" + "description": "Specifies that if a subset of the input objects has identical properties and values, only a single member of the subset should be selected." }, { "name": "-Wait", - "description": "Indicates that the cmdlet turns off optimization. PowerShell runs commands in the order that they appear in the command pipeline and lets them generate all objects. By default, if you include a `Select-Object` command with the First or Index parameters in a command pipeline, PowerShell stops the command that generates the objects as soon as the selected number of objects is generated.\n" + "description": "Indicates that the cmdlet turns off optimization. PowerShell runs commands in the order that they appear in the command pipeline and lets them generate all objects. By default, if you include a `Select-Object` command with the First or Index parameters in a command pipeline, PowerShell stops the command that generates the objects as soon as the selected number of objects is generated." }, { "name": [ @@ -273,7 +277,7 @@ "args": [ { "name": "-Property", - "description": "Specifies the properties to select. These properties are added as NoteProperty members to the output objects. Wildcards are permitted. If the input object doesn't have the property named, the value of the new NoteProperty is set to `$null`.\n" + "description": "Specifies the properties to select. These properties are added as NoteProperty members to the output objects. Wildcards are permitted. If the input object doesn't have the property named, the value of the new NoteProperty is set to `$null`." } ], "description": "Selects objects or object properties.", diff --git a/command-signatures/json/autogenerated/powershell/select-string.json b/command-signatures/json/autogenerated/powershell/select-string.json index 9558e172..f8f4502e 100644 --- a/command-signatures/json/autogenerated/powershell/select-string.json +++ b/command-signatures/json/autogenerated/powershell/select-string.json @@ -3,7 +3,7 @@ "options": [ { "name": "-AllMatches", - "description": "Indicates that the cmdlet searches for more than one match in each line of text. Without this parameter, `Select-String` finds only the first match in each line of text.\n" + "description": "Indicates that the cmdlet searches for more than one match in each line of text. Without this parameter, `Select-String` finds only the first match in each line of text." }, { "name": "-CaseSensitive", @@ -16,17 +16,2694 @@ "name": "System.Int32[]" } ], - "description": "Captures the specified number of lines before and after the line that matches the pattern.\n" + "description": "Captures the specified number of lines before and after the line that matches the pattern." }, { "name": "-Culture", "args": [ { "name": "System.String", - "default": "Culture of the current PowerShell session" + "suggestions": [ + { + "name": "aa" + }, + { + "name": "aa-DJ" + }, + { + "name": "aa-ER" + }, + { + "name": "aa-ET" + }, + { + "name": "af" + }, + { + "name": "af-NA" + }, + { + "name": "af-ZA" + }, + { + "name": "agq" + }, + { + "name": "agq-CM" + }, + { + "name": "ak" + }, + { + "name": "ak-GH" + }, + { + "name": "am" + }, + { + "name": "am-ET" + }, + { + "name": "ar" + }, + { + "name": "ar-001" + }, + { + "name": "ar-AE" + }, + { + "name": "ar-BH" + }, + { + "name": "ar-DJ" + }, + { + "name": "ar-DZ" + }, + { + "name": "ar-EG" + }, + { + "name": "ar-ER" + }, + { + "name": "ar-IL" + }, + { + "name": "ar-IQ" + }, + { + "name": "ar-JO" + }, + { + "name": "ar-KM" + }, + { + "name": "ar-KW" + }, + { + "name": "ar-LB" + }, + { + "name": "ar-LY" + }, + { + "name": "ar-MA" + }, + { + "name": "ar-MR" + }, + { + "name": "ar-OM" + }, + { + "name": "ar-PS" + }, + { + "name": "ar-QA" + }, + { + "name": "ar-SA" + }, + { + "name": "ar-SD" + }, + { + "name": "ar-SO" + }, + { + "name": "ar-SS" + }, + { + "name": "ar-SY" + }, + { + "name": "ar-TD" + }, + { + "name": "ar-TN" + }, + { + "name": "ar-YE" + }, + { + "name": "arn" + }, + { + "name": "arn-CL" + }, + { + "name": "as" + }, + { + "name": "as-IN" + }, + { + "name": "asa" + }, + { + "name": "asa-TZ" + }, + { + "name": "ast" + }, + { + "name": "ast-ES" + }, + { + "name": "az" + }, + { + "name": "az-Cyrl" + }, + { + "name": "az-Cyrl-AZ" + }, + { + "name": "az-Latn" + }, + { + "name": "az-Latn-AZ" + }, + { + "name": "ba" + }, + { + "name": "ba-RU" + }, + { + "name": "bas" + }, + { + "name": "bas-CM" + }, + { + "name": "be" + }, + { + "name": "be-BY" + }, + { + "name": "bem" + }, + { + "name": "bem-ZM" + }, + { + "name": "bez" + }, + { + "name": "bez-TZ" + }, + { + "name": "bg" + }, + { + "name": "bg-BG" + }, + { + "name": "bgc" + }, + { + "name": "bgc-IN" + }, + { + "name": "bho" + }, + { + "name": "bho-IN" + }, + { + "name": "bin" + }, + { + "name": "bin-NG" + }, + { + "name": "bm" + }, + { + "name": "bm-ML" + }, + { + "name": "bn" + }, + { + "name": "bn-BD" + }, + { + "name": "bn-IN" + }, + { + "name": "bo" + }, + { + "name": "bo-CN" + }, + { + "name": "bo-IN" + }, + { + "name": "br" + }, + { + "name": "br-FR" + }, + { + "name": "brx" + }, + { + "name": "brx-IN" + }, + { + "name": "bs" + }, + { + "name": "bs-Cyrl" + }, + { + "name": "bs-Cyrl-BA" + }, + { + "name": "bs-Latn" + }, + { + "name": "bs-Latn-BA" + }, + { + "name": "byn" + }, + { + "name": "byn-ER" + }, + { + "name": "ca" + }, + { + "name": "ca-AD" + }, + { + "name": "ca-ES" + }, + { + "name": "ca-FR" + }, + { + "name": "ca-IT" + }, + { + "name": "ccp" + }, + { + "name": "ccp-BD" + }, + { + "name": "ccp-IN" + }, + { + "name": "ce" + }, + { + "name": "ce-RU" + }, + { + "name": "ceb" + }, + { + "name": "ceb-PH" + }, + { + "name": "cgg" + }, + { + "name": "cgg-UG" + }, + { + "name": "chr" + }, + { + "name": "chr-US" + }, + { + "name": "ckb" + }, + { + "name": "ckb-IQ" + }, + { + "name": "ckb-IR" + }, + { + "name": "co" + }, + { + "name": "co-FR" + }, + { + "name": "cs" + }, + { + "name": "cs-CZ" + }, + { + "name": "cu" + }, + { + "name": "cu-RU" + }, + { + "name": "Current" + }, + { + "name": "cv" + }, + { + "name": "cv-RU" + }, + { + "name": "cy" + }, + { + "name": "cy-GB" + }, + { + "name": "da" + }, + { + "name": "da-DK" + }, + { + "name": "da-GL" + }, + { + "name": "dav" + }, + { + "name": "dav-KE" + }, + { + "name": "de" + }, + { + "name": "de-AT" + }, + { + "name": "de-BE" + }, + { + "name": "de-CH" + }, + { + "name": "de-DE" + }, + { + "name": "de-IT" + }, + { + "name": "de-LI" + }, + { + "name": "de-LU" + }, + { + "name": "dje" + }, + { + "name": "dje-NE" + }, + { + "name": "doi" + }, + { + "name": "doi-IN" + }, + { + "name": "dsb" + }, + { + "name": "dsb-DE" + }, + { + "name": "dua" + }, + { + "name": "dua-CM" + }, + { + "name": "dv" + }, + { + "name": "dv-MV" + }, + { + "name": "dyo" + }, + { + "name": "dyo-SN" + }, + { + "name": "dz" + }, + { + "name": "dz-BT" + }, + { + "name": "ebu" + }, + { + "name": "ebu-KE" + }, + { + "name": "ee" + }, + { + "name": "ee-GH" + }, + { + "name": "ee-TG" + }, + { + "name": "el" + }, + { + "name": "el-CY" + }, + { + "name": "el-GR" + }, + { + "name": "en" + }, + { + "name": "en-001" + }, + { + "name": "en-029" + }, + { + "name": "en-150" + }, + { + "name": "en-AE" + }, + { + "name": "en-AG" + }, + { + "name": "en-AI" + }, + { + "name": "en-AS" + }, + { + "name": "en-AT" + }, + { + "name": "en-AU" + }, + { + "name": "en-BB" + }, + { + "name": "en-BE" + }, + { + "name": "en-BI" + }, + { + "name": "en-BM" + }, + { + "name": "en-BS" + }, + { + "name": "en-BW" + }, + { + "name": "en-BZ" + }, + { + "name": "en-CA" + }, + { + "name": "en-CC" + }, + { + "name": "en-CH" + }, + { + "name": "en-CK" + }, + { + "name": "en-CM" + }, + { + "name": "en-CX" + }, + { + "name": "en-CY" + }, + { + "name": "en-DE" + }, + { + "name": "en-DK" + }, + { + "name": "en-DM" + }, + { + "name": "en-ER" + }, + { + "name": "en-FI" + }, + { + "name": "en-FJ" + }, + { + "name": "en-FK" + }, + { + "name": "en-FM" + }, + { + "name": "en-GB" + }, + { + "name": "en-GD" + }, + { + "name": "en-GG" + }, + { + "name": "en-GH" + }, + { + "name": "en-GI" + }, + { + "name": "en-GM" + }, + { + "name": "en-GU" + }, + { + "name": "en-GY" + }, + { + "name": "en-HK" + }, + { + "name": "en-ID" + }, + { + "name": "en-IE" + }, + { + "name": "en-IL" + }, + { + "name": "en-IM" + }, + { + "name": "en-IN" + }, + { + "name": "en-IO" + }, + { + "name": "en-JE" + }, + { + "name": "en-JM" + }, + { + "name": "en-KE" + }, + { + "name": "en-KI" + }, + { + "name": "en-KN" + }, + { + "name": "en-KY" + }, + { + "name": "en-LC" + }, + { + "name": "en-LR" + }, + { + "name": "en-LS" + }, + { + "name": "en-MG" + }, + { + "name": "en-MH" + }, + { + "name": "en-MO" + }, + { + "name": "en-MP" + }, + { + "name": "en-MS" + }, + { + "name": "en-MT" + }, + { + "name": "en-MU" + }, + { + "name": "en-MV" + }, + { + "name": "en-MW" + }, + { + "name": "en-MY" + }, + { + "name": "en-NA" + }, + { + "name": "en-NF" + }, + { + "name": "en-NG" + }, + { + "name": "en-NL" + }, + { + "name": "en-NR" + }, + { + "name": "en-NU" + }, + { + "name": "en-NZ" + }, + { + "name": "en-PG" + }, + { + "name": "en-PH" + }, + { + "name": "en-PK" + }, + { + "name": "en-PN" + }, + { + "name": "en-PR" + }, + { + "name": "en-PW" + }, + { + "name": "en-RW" + }, + { + "name": "en-SB" + }, + { + "name": "en-SC" + }, + { + "name": "en-SD" + }, + { + "name": "en-SE" + }, + { + "name": "en-SG" + }, + { + "name": "en-SH" + }, + { + "name": "en-SI" + }, + { + "name": "en-SL" + }, + { + "name": "en-SS" + }, + { + "name": "en-SX" + }, + { + "name": "en-SZ" + }, + { + "name": "en-TC" + }, + { + "name": "en-TK" + }, + { + "name": "en-TO" + }, + { + "name": "en-TT" + }, + { + "name": "en-TV" + }, + { + "name": "en-TZ" + }, + { + "name": "en-UG" + }, + { + "name": "en-UM" + }, + { + "name": "en-US" + }, + { + "name": "en-US-POSIX" + }, + { + "name": "en-VC" + }, + { + "name": "en-VG" + }, + { + "name": "en-VI" + }, + { + "name": "en-VU" + }, + { + "name": "en-WS" + }, + { + "name": "en-ZA" + }, + { + "name": "en-ZM" + }, + { + "name": "en-ZW" + }, + { + "name": "eo" + }, + { + "name": "eo-001" + }, + { + "name": "es" + }, + { + "name": "es-419" + }, + { + "name": "es-AR" + }, + { + "name": "es-BO" + }, + { + "name": "es-BR" + }, + { + "name": "es-BZ" + }, + { + "name": "es-CL" + }, + { + "name": "es-CO" + }, + { + "name": "es-CR" + }, + { + "name": "es-CU" + }, + { + "name": "es-DO" + }, + { + "name": "es-EC" + }, + { + "name": "es-ES" + }, + { + "name": "es-GQ" + }, + { + "name": "es-GT" + }, + { + "name": "es-HN" + }, + { + "name": "es-MX" + }, + { + "name": "es-NI" + }, + { + "name": "es-PA" + }, + { + "name": "es-PE" + }, + { + "name": "es-PH" + }, + { + "name": "es-PR" + }, + { + "name": "es-PY" + }, + { + "name": "es-SV" + }, + { + "name": "es-US" + }, + { + "name": "es-UY" + }, + { + "name": "es-VE" + }, + { + "name": "et" + }, + { + "name": "et-EE" + }, + { + "name": "eu" + }, + { + "name": "eu-ES" + }, + { + "name": "ewo" + }, + { + "name": "ewo-CM" + }, + { + "name": "fa" + }, + { + "name": "fa-AF" + }, + { + "name": "fa-IR" + }, + { + "name": "ff" + }, + { + "name": "ff-Adlm" + }, + { + "name": "ff-Adlm-BF" + }, + { + "name": "ff-Adlm-CM" + }, + { + "name": "ff-Adlm-GH" + }, + { + "name": "ff-Adlm-GM" + }, + { + "name": "ff-Adlm-GN" + }, + { + "name": "ff-Adlm-GW" + }, + { + "name": "ff-Adlm-LR" + }, + { + "name": "ff-Adlm-MR" + }, + { + "name": "ff-Adlm-NE" + }, + { + "name": "ff-Adlm-NG" + }, + { + "name": "ff-Adlm-SL" + }, + { + "name": "ff-Adlm-SN" + }, + { + "name": "ff-Latn" + }, + { + "name": "ff-Latn-BF" + }, + { + "name": "ff-Latn-CM" + }, + { + "name": "ff-Latn-GH" + }, + { + "name": "ff-Latn-GM" + }, + { + "name": "ff-Latn-GN" + }, + { + "name": "ff-Latn-GW" + }, + { + "name": "ff-Latn-LR" + }, + { + "name": "ff-Latn-MR" + }, + { + "name": "ff-Latn-NE" + }, + { + "name": "ff-Latn-NG" + }, + { + "name": "ff-Latn-SL" + }, + { + "name": "ff-Latn-SN" + }, + { + "name": "fi" + }, + { + "name": "fi-FI" + }, + { + "name": "fil" + }, + { + "name": "fil-PH" + }, + { + "name": "fo" + }, + { + "name": "fo-DK" + }, + { + "name": "fo-FO" + }, + { + "name": "fr" + }, + { + "name": "fr-029" + }, + { + "name": "fr-BE" + }, + { + "name": "fr-BF" + }, + { + "name": "fr-BI" + }, + { + "name": "fr-BJ" + }, + { + "name": "fr-BL" + }, + { + "name": "fr-CA" + }, + { + "name": "fr-CD" + }, + { + "name": "fr-CF" + }, + { + "name": "fr-CG" + }, + { + "name": "fr-CH" + }, + { + "name": "fr-CI" + }, + { + "name": "fr-CM" + }, + { + "name": "fr-DJ" + }, + { + "name": "fr-DZ" + }, + { + "name": "fr-FR" + }, + { + "name": "fr-GA" + }, + { + "name": "fr-GF" + }, + { + "name": "fr-GN" + }, + { + "name": "fr-GP" + }, + { + "name": "fr-GQ" + }, + { + "name": "fr-HT" + }, + { + "name": "fr-KM" + }, + { + "name": "fr-LU" + }, + { + "name": "fr-MA" + }, + { + "name": "fr-MC" + }, + { + "name": "fr-MF" + }, + { + "name": "fr-MG" + }, + { + "name": "fr-ML" + }, + { + "name": "fr-MQ" + }, + { + "name": "fr-MR" + }, + { + "name": "fr-MU" + }, + { + "name": "fr-NC" + }, + { + "name": "fr-NE" + }, + { + "name": "fr-PF" + }, + { + "name": "fr-PM" + }, + { + "name": "fr-RE" + }, + { + "name": "fr-RW" + }, + { + "name": "fr-SC" + }, + { + "name": "fr-SN" + }, + { + "name": "fr-SY" + }, + { + "name": "fr-TD" + }, + { + "name": "fr-TG" + }, + { + "name": "fr-TN" + }, + { + "name": "fr-VU" + }, + { + "name": "fr-WF" + }, + { + "name": "fr-YT" + }, + { + "name": "fur" + }, + { + "name": "fur-IT" + }, + { + "name": "fy" + }, + { + "name": "fy-NL" + }, + { + "name": "ga" + }, + { + "name": "ga-GB" + }, + { + "name": "ga-IE" + }, + { + "name": "gd" + }, + { + "name": "gd-GB" + }, + { + "name": "gl" + }, + { + "name": "gl-ES" + }, + { + "name": "gn" + }, + { + "name": "gn-PY" + }, + { + "name": "gsw" + }, + { + "name": "gsw-CH" + }, + { + "name": "gsw-FR" + }, + { + "name": "gsw-LI" + }, + { + "name": "gu" + }, + { + "name": "gu-IN" + }, + { + "name": "guz" + }, + { + "name": "guz-KE" + }, + { + "name": "gv" + }, + { + "name": "gv-IM" + }, + { + "name": "ha" + }, + { + "name": "ha-GH" + }, + { + "name": "ha-NE" + }, + { + "name": "ha-NG" + }, + { + "name": "haw" + }, + { + "name": "haw-US" + }, + { + "name": "he" + }, + { + "name": "he-IL" + }, + { + "name": "hi" + }, + { + "name": "hi-IN" + }, + { + "name": "hi-Latn" + }, + { + "name": "hi-Latn-IN" + }, + { + "name": "hr" + }, + { + "name": "hr-BA" + }, + { + "name": "hr-HR" + }, + { + "name": "hsb" + }, + { + "name": "hsb-DE" + }, + { + "name": "hu" + }, + { + "name": "hu-HU" + }, + { + "name": "hy" + }, + { + "name": "hy-AM" + }, + { + "name": "ia" + }, + { + "name": "ia-001" + }, + { + "name": "ibb" + }, + { + "name": "ibb-NG" + }, + { + "name": "id" + }, + { + "name": "id-ID" + }, + { + "name": "ig" + }, + { + "name": "ig-NG" + }, + { + "name": "ii" + }, + { + "name": "ii-CN" + }, + { + "name": "Invariant" + }, + { + "name": "is" + }, + { + "name": "is-IS" + }, + { + "name": "it" + }, + { + "name": "it-CH" + }, + { + "name": "it-IT" + }, + { + "name": "it-SM" + }, + { + "name": "it-VA" + }, + { + "name": "iu" + }, + { + "name": "iu-CA" + }, + { + "name": "iu-Latn" + }, + { + "name": "iu-Latn-CA" + }, + { + "name": "ja" + }, + { + "name": "ja-JP" + }, + { + "name": "jgo" + }, + { + "name": "jgo-CM" + }, + { + "name": "jmc" + }, + { + "name": "jmc-TZ" + }, + { + "name": "jv" + }, + { + "name": "jv-ID" + }, + { + "name": "jv-Java" + }, + { + "name": "jv-Java-ID" + }, + { + "name": "ka" + }, + { + "name": "ka-GE" + }, + { + "name": "kab" + }, + { + "name": "kab-DZ" + }, + { + "name": "kam" + }, + { + "name": "kam-KE" + }, + { + "name": "kde" + }, + { + "name": "kde-TZ" + }, + { + "name": "kea" + }, + { + "name": "kea-CV" + }, + { + "name": "kgp" + }, + { + "name": "kgp-BR" + }, + { + "name": "khq" + }, + { + "name": "khq-ML" + }, + { + "name": "ki" + }, + { + "name": "ki-KE" + }, + { + "name": "kk" + }, + { + "name": "kk-KZ" + }, + { + "name": "kkj" + }, + { + "name": "kkj-CM" + }, + { + "name": "kl" + }, + { + "name": "kl-GL" + }, + { + "name": "kln" + }, + { + "name": "kln-KE" + }, + { + "name": "km" + }, + { + "name": "km-KH" + }, + { + "name": "kn" + }, + { + "name": "kn-IN" + }, + { + "name": "ko" + }, + { + "name": "ko-KP" + }, + { + "name": "ko-KR" + }, + { + "name": "kok" + }, + { + "name": "kok-IN" + }, + { + "name": "kr" + }, + { + "name": "kr-Latn" + }, + { + "name": "kr-Latn-NG" + }, + { + "name": "ks" + }, + { + "name": "ks-Arab" + }, + { + "name": "ks-Arab-IN" + }, + { + "name": "ks-Deva" + }, + { + "name": "ks-Deva-IN" + }, + { + "name": "ksb" + }, + { + "name": "ksb-TZ" + }, + { + "name": "ksf" + }, + { + "name": "ksf-CM" + }, + { + "name": "ksh" + }, + { + "name": "ksh-DE" + }, + { + "name": "kw" + }, + { + "name": "kw-GB" + }, + { + "name": "ky" + }, + { + "name": "ky-KG" + }, + { + "name": "la" + }, + { + "name": "la-VA" + }, + { + "name": "lag" + }, + { + "name": "lag-TZ" + }, + { + "name": "lb" + }, + { + "name": "lb-LU" + }, + { + "name": "lg" + }, + { + "name": "lg-UG" + }, + { + "name": "lkt" + }, + { + "name": "lkt-US" + }, + { + "name": "ln" + }, + { + "name": "ln-AO" + }, + { + "name": "ln-CD" + }, + { + "name": "ln-CF" + }, + { + "name": "ln-CG" + }, + { + "name": "lo" + }, + { + "name": "lo-LA" + }, + { + "name": "lrc" + }, + { + "name": "lrc-IQ" + }, + { + "name": "lrc-IR" + }, + { + "name": "lt" + }, + { + "name": "lt-LT" + }, + { + "name": "lu" + }, + { + "name": "lu-CD" + }, + { + "name": "luo" + }, + { + "name": "luo-KE" + }, + { + "name": "luy" + }, + { + "name": "luy-KE" + }, + { + "name": "lv" + }, + { + "name": "lv-LV" + }, + { + "name": "mai" + }, + { + "name": "mai-IN" + }, + { + "name": "mas" + }, + { + "name": "mas-KE" + }, + { + "name": "mas-TZ" + }, + { + "name": "mer" + }, + { + "name": "mer-KE" + }, + { + "name": "mfe" + }, + { + "name": "mfe-MU" + }, + { + "name": "mg" + }, + { + "name": "mg-MG" + }, + { + "name": "mgh" + }, + { + "name": "mgh-MZ" + }, + { + "name": "mgo" + }, + { + "name": "mgo-CM" + }, + { + "name": "mi" + }, + { + "name": "mi-NZ" + }, + { + "name": "mk" + }, + { + "name": "mk-MK" + }, + { + "name": "ml" + }, + { + "name": "ml-IN" + }, + { + "name": "mn" + }, + { + "name": "mn-MN" + }, + { + "name": "mn-Mong" + }, + { + "name": "mn-Mong-CN" + }, + { + "name": "mn-Mong-MN" + }, + { + "name": "mni" + }, + { + "name": "mni-Beng" + }, + { + "name": "mni-Beng-IN" + }, + { + "name": "moh" + }, + { + "name": "moh-CA" + }, + { + "name": "mr" + }, + { + "name": "mr-IN" + }, + { + "name": "ms" + }, + { + "name": "ms-BN" + }, + { + "name": "ms-ID" + }, + { + "name": "ms-MY" + }, + { + "name": "ms-SG" + }, + { + "name": "mt" + }, + { + "name": "mt-MT" + }, + { + "name": "mua" + }, + { + "name": "mua-CM" + }, + { + "name": "my" + }, + { + "name": "my-MM" + }, + { + "name": "mzn" + }, + { + "name": "mzn-IR" + }, + { + "name": "naq" + }, + { + "name": "naq-NA" + }, + { + "name": "nb" + }, + { + "name": "nb-NO" + }, + { + "name": "nb-SJ" + }, + { + "name": "nd" + }, + { + "name": "nd-ZW" + }, + { + "name": "nds" + }, + { + "name": "nds-DE" + }, + { + "name": "nds-NL" + }, + { + "name": "ne" + }, + { + "name": "ne-IN" + }, + { + "name": "ne-NP" + }, + { + "name": "nl" + }, + { + "name": "nl-AW" + }, + { + "name": "nl-BE" + }, + { + "name": "nl-BQ" + }, + { + "name": "nl-CW" + }, + { + "name": "nl-NL" + }, + { + "name": "nl-SR" + }, + { + "name": "nl-SX" + }, + { + "name": "nmg" + }, + { + "name": "nmg-CM" + }, + { + "name": "nn" + }, + { + "name": "nn-NO" + }, + { + "name": "nnh" + }, + { + "name": "nnh-CM" + }, + { + "name": "no" + }, + { + "name": "nqo" + }, + { + "name": "nqo-GN" + }, + { + "name": "nr" + }, + { + "name": "nr-ZA" + }, + { + "name": "nso" + }, + { + "name": "nso-ZA" + }, + { + "name": "nus" + }, + { + "name": "nus-SS" + }, + { + "name": "nyn" + }, + { + "name": "nyn-UG" + }, + { + "name": "oc" + }, + { + "name": "oc-ES" + }, + { + "name": "oc-FR" + }, + { + "name": "om" + }, + { + "name": "om-ET" + }, + { + "name": "om-KE" + }, + { + "name": "or" + }, + { + "name": "or-IN" + }, + { + "name": "Ordinal" + }, + { + "name": "os" + }, + { + "name": "os-GE" + }, + { + "name": "os-RU" + }, + { + "name": "pa" + }, + { + "name": "pa-Arab" + }, + { + "name": "pa-Arab-PK" + }, + { + "name": "pa-Guru" + }, + { + "name": "pa-Guru-IN" + }, + { + "name": "pap" + }, + { + "name": "pap-029" + }, + { + "name": "pcm" + }, + { + "name": "pcm-NG" + }, + { + "name": "pl" + }, + { + "name": "pl-PL" + }, + { + "name": "prg" + }, + { + "name": "prg-001" + }, + { + "name": "ps" + }, + { + "name": "ps-AF" + }, + { + "name": "ps-PK" + }, + { + "name": "pt" + }, + { + "name": "pt-AO" + }, + { + "name": "pt-BR" + }, + { + "name": "pt-CH" + }, + { + "name": "pt-CV" + }, + { + "name": "pt-GQ" + }, + { + "name": "pt-GW" + }, + { + "name": "pt-LU" + }, + { + "name": "pt-MO" + }, + { + "name": "pt-MZ" + }, + { + "name": "pt-PT" + }, + { + "name": "pt-ST" + }, + { + "name": "pt-TL" + }, + { + "name": "qu" + }, + { + "name": "qu-BO" + }, + { + "name": "qu-EC" + }, + { + "name": "qu-PE" + }, + { + "name": "quc" + }, + { + "name": "quc-GT" + }, + { + "name": "raj" + }, + { + "name": "raj-IN" + }, + { + "name": "rm" + }, + { + "name": "rm-CH" + }, + { + "name": "rn" + }, + { + "name": "rn-BI" + }, + { + "name": "ro" + }, + { + "name": "ro-MD" + }, + { + "name": "ro-RO" + }, + { + "name": "rof" + }, + { + "name": "rof-TZ" + }, + { + "name": "ru" + }, + { + "name": "ru-BY" + }, + { + "name": "ru-KG" + }, + { + "name": "ru-KZ" + }, + { + "name": "ru-MD" + }, + { + "name": "ru-RU" + }, + { + "name": "ru-UA" + }, + { + "name": "rw" + }, + { + "name": "rw-RW" + }, + { + "name": "rwk" + }, + { + "name": "rwk-TZ" + }, + { + "name": "sa" + }, + { + "name": "sa-IN" + }, + { + "name": "sah" + }, + { + "name": "sah-RU" + }, + { + "name": "saq" + }, + { + "name": "saq-KE" + }, + { + "name": "sat" + }, + { + "name": "sat-Olck" + }, + { + "name": "sat-Olck-IN" + }, + { + "name": "sbp" + }, + { + "name": "sbp-TZ" + }, + { + "name": "sc" + }, + { + "name": "sc-IT" + }, + { + "name": "sd" + }, + { + "name": "sd-Arab" + }, + { + "name": "sd-Arab-PK" + }, + { + "name": "sd-Deva" + }, + { + "name": "sd-Deva-IN" + }, + { + "name": "se" + }, + { + "name": "se-FI" + }, + { + "name": "se-NO" + }, + { + "name": "se-SE" + }, + { + "name": "seh" + }, + { + "name": "seh-MZ" + }, + { + "name": "ses" + }, + { + "name": "ses-ML" + }, + { + "name": "sg" + }, + { + "name": "sg-CF" + }, + { + "name": "shi" + }, + { + "name": "shi-Latn" + }, + { + "name": "shi-Latn-MA" + }, + { + "name": "shi-Tfng" + }, + { + "name": "shi-Tfng-MA" + }, + { + "name": "si" + }, + { + "name": "si-LK" + }, + { + "name": "sk" + }, + { + "name": "sk-SK" + }, + { + "name": "sl" + }, + { + "name": "sl-SI" + }, + { + "name": "sma" + }, + { + "name": "sma-NO" + }, + { + "name": "sma-SE" + }, + { + "name": "smj" + }, + { + "name": "smj-NO" + }, + { + "name": "smj-SE" + }, + { + "name": "smn" + }, + { + "name": "smn-FI" + }, + { + "name": "sms" + }, + { + "name": "sms-FI" + }, + { + "name": "sn" + }, + { + "name": "sn-ZW" + }, + { + "name": "so" + }, + { + "name": "so-DJ" + }, + { + "name": "so-ET" + }, + { + "name": "so-KE" + }, + { + "name": "so-SO" + }, + { + "name": "sq" + }, + { + "name": "sq-AL" + }, + { + "name": "sq-MK" + }, + { + "name": "sq-XK" + }, + { + "name": "sr" + }, + { + "name": "sr-Cyrl" + }, + { + "name": "sr-Cyrl-BA" + }, + { + "name": "sr-Cyrl-ME" + }, + { + "name": "sr-Cyrl-RS" + }, + { + "name": "sr-Cyrl-XK" + }, + { + "name": "sr-Latn" + }, + { + "name": "sr-Latn-BA" + }, + { + "name": "sr-Latn-ME" + }, + { + "name": "sr-Latn-RS" + }, + { + "name": "sr-Latn-XK" + }, + { + "name": "ss" + }, + { + "name": "ss-SZ" + }, + { + "name": "ss-ZA" + }, + { + "name": "ssy" + }, + { + "name": "ssy-ER" + }, + { + "name": "st" + }, + { + "name": "st-LS" + }, + { + "name": "st-ZA" + }, + { + "name": "su" + }, + { + "name": "su-Latn" + }, + { + "name": "su-Latn-ID" + }, + { + "name": "sv" + }, + { + "name": "sv-AX" + }, + { + "name": "sv-FI" + }, + { + "name": "sv-SE" + }, + { + "name": "sw" + }, + { + "name": "sw-CD" + }, + { + "name": "sw-KE" + }, + { + "name": "sw-TZ" + }, + { + "name": "sw-UG" + }, + { + "name": "syr" + }, + { + "name": "syr-SY" + }, + { + "name": "ta" + }, + { + "name": "ta-IN" + }, + { + "name": "ta-LK" + }, + { + "name": "ta-MY" + }, + { + "name": "ta-SG" + }, + { + "name": "te" + }, + { + "name": "te-IN" + }, + { + "name": "teo" + }, + { + "name": "teo-KE" + }, + { + "name": "teo-UG" + }, + { + "name": "tg" + }, + { + "name": "tg-TJ" + }, + { + "name": "th" + }, + { + "name": "th-TH" + }, + { + "name": "ti" + }, + { + "name": "ti-ER" + }, + { + "name": "ti-ET" + }, + { + "name": "tig" + }, + { + "name": "tig-ER" + }, + { + "name": "tk" + }, + { + "name": "tk-TM" + }, + { + "name": "tn" + }, + { + "name": "tn-BW" + }, + { + "name": "tn-ZA" + }, + { + "name": "to" + }, + { + "name": "to-TO" + }, + { + "name": "tr" + }, + { + "name": "tr-CY" + }, + { + "name": "tr-TR" + }, + { + "name": "ts" + }, + { + "name": "ts-ZA" + }, + { + "name": "tt" + }, + { + "name": "tt-RU" + }, + { + "name": "twq" + }, + { + "name": "twq-NE" + }, + { + "name": "tzm" + }, + { + "name": "tzm-Arab" + }, + { + "name": "tzm-Arab-MA" + }, + { + "name": "tzm-DZ" + }, + { + "name": "tzm-MA" + }, + { + "name": "tzm-Tfng" + }, + { + "name": "tzm-Tfng-MA" + }, + { + "name": "ug" + }, + { + "name": "ug-CN" + }, + { + "name": "uk" + }, + { + "name": "uk-UA" + }, + { + "name": "ur" + }, + { + "name": "ur-IN" + }, + { + "name": "ur-PK" + }, + { + "name": "uz" + }, + { + "name": "uz-Arab" + }, + { + "name": "uz-Arab-AF" + }, + { + "name": "uz-Cyrl" + }, + { + "name": "uz-Cyrl-UZ" + }, + { + "name": "uz-Latn" + }, + { + "name": "uz-Latn-UZ" + }, + { + "name": "vai" + }, + { + "name": "vai-Latn" + }, + { + "name": "vai-Latn-LR" + }, + { + "name": "vai-Vaii" + }, + { + "name": "vai-Vaii-LR" + }, + { + "name": "ve" + }, + { + "name": "ve-ZA" + }, + { + "name": "vi" + }, + { + "name": "vi-VN" + }, + { + "name": "vo" + }, + { + "name": "vo-001" + }, + { + "name": "vun" + }, + { + "name": "vun-TZ" + }, + { + "name": "wae" + }, + { + "name": "wae-CH" + }, + { + "name": "wal" + }, + { + "name": "wal-ET" + }, + { + "name": "wo" + }, + { + "name": "wo-SN" + }, + { + "name": "xh" + }, + { + "name": "xh-ZA" + }, + { + "name": "xog" + }, + { + "name": "xog-UG" + }, + { + "name": "yav" + }, + { + "name": "yav-CM" + }, + { + "name": "yi" + }, + { + "name": "yi-001" + }, + { + "name": "yo" + }, + { + "name": "yo-BJ" + }, + { + "name": "yo-NG" + }, + { + "name": "yrl" + }, + { + "name": "yrl-BR" + }, + { + "name": "yrl-CO" + }, + { + "name": "yrl-VE" + }, + { + "name": "zgh" + }, + { + "name": "zgh-MA" + }, + { + "name": "zh" + }, + { + "name": "zh-Hans" + }, + { + "name": "zh-Hans-CN" + }, + { + "name": "zh-Hans-HK" + }, + { + "name": "zh-Hans-MO" + }, + { + "name": "zh-Hans-SG" + }, + { + "name": "zh-Hant" + }, + { + "name": "zh-Hant-HK" + }, + { + "name": "zh-Hant-MO" + }, + { + "name": "zh-Hant-TW" + }, + { + "name": "zu" + }, + { + "name": "zu-ZA" + } + ] } ], - "description": "Specifies a culture name to match the specified pattern. The Culture parameter must be used with the SimpleMatch parameter. The default behavior uses the culture of the current PowerShell runspace (session).\n" + "description": "Specifies a culture name to match the specified pattern. The Culture parameter must be used with the SimpleMatch parameter. The default behavior uses the culture of the current PowerShell runspace (session)." }, { "name": "-Encoding", @@ -35,40 +2712,42 @@ "name": "System.Text.Encoding", "suggestions": [ { - "name": "ASCII" + "name": "ansi" }, { - "name": "BigEndianUnicode" + "name": "ascii" }, { - "name": "BigEndianUTF32" + "name": "bigendianunicode" }, { - "name": "OEM" + "name": "bigendianutf32" }, { - "name": "Unicode" + "name": "oem" }, { - "name": "UTF7" + "name": "unicode" }, { - "name": "UTF8" + "name": "utf32" }, { - "name": "UTF8BOM" + "name": "utf7" }, { - "name": "UTF8NoBOM" + "name": "utf8" }, { - "name": "UTF32" + "name": "utf8BOM" + }, + { + "name": "utf8NoBOM" } - ], - "default": "UTF8NoBOM" + ] } ], - "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`.\n" + "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`." }, { "name": "-Exclude", @@ -96,11 +2775,11 @@ } ], "isRequired": true, - "description": "Specifies the text to be searched. Enter a variable that contains the text, or type a command or expression that gets the text.\n" + "description": "Specifies the text to be searched. Enter a variable that contains the text, or type a command or expression that gets the text." }, { "name": "-List", - "description": "Only the first instance of matching text is returned from each input file. This is the most efficient way to retrieve a list of files that have contents matching the regular expression.\n" + "description": "Only the first instance of matching text is returned from each input file. This is the most efficient way to retrieve a list of files that have contents matching the regular expression." }, { "name": [ @@ -114,11 +2793,11 @@ } ], "isRequired": true, - "description": "Specifies the path to the files to be searched. The value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences. For more information, see about_Quoting_Rules (../Microsoft.Powershell.Core/About/about_Quoting_Rules.md)." + "description": "Specifies the path to the files to be searched. The value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences. For more information, see [about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md)." }, { "name": "-NoEmphasis", - "description": "By default, `Select-String` highlights the string that matches the pattern you searched for with the Pattern parameter. The NoEmphasis parameter disables the highlighting.\n" + "description": "By default, `Select-String` highlights the string that matches the pattern you searched for with the Pattern parameter. The NoEmphasis parameter disables the highlighting." }, { "name": "-NotMatch", @@ -128,12 +2807,11 @@ "name": "-Path", "args": [ { - "name": "System.String[]", - "default": "Local directory" + "name": "System.String[]" } ], "isRequired": true, - "description": "Specifies the path to the files to search. Wildcards are permitted. The default location is the local directory.\n" + "description": "Specifies the path to the files to search. Wildcards are permitted. The default location is the local directory." }, { "name": "-Pattern", @@ -143,20 +2821,20 @@ } ], "isRequired": true, - "description": "Specifies the text to find on each line. The pattern value is treated as a regular expression.\n" + "description": "Specifies the text to find on each line. The pattern value is treated as a regular expression. The parameter accepts multiple patterns in an array. If you specify more than one pattern, `Select-String` returns matches for each pattern." }, { "name": "-Quiet", - "description": "Indicates that the cmdlet returns a Boolean value (True or False), instead of a MatchInfo object. The value is True if the pattern is found; otherwise the value is False." + "description": "Indicates that the cmdlet returns a simple response instead of a MatchInfo object. The returned value is `$true` if the pattern is found or `$null` if the pattern is not found." }, { "name": "-Raw", "isRequired": true, - "description": "Causes the cmdlet to output only the matching strings, rather than MatchInfo objects. This is the results in behavior that's the most similar to the Unix grep or Windows findstr.exe commands.\n" + "description": "Causes the cmdlet to output only the matching strings, rather than MatchInfo objects. This behavior is most similar to the Unix `grep` or Windows `findstr.exe` commands." }, { "name": "-SimpleMatch", - "description": "Indicates that the cmdlet uses a simple match rather than a regular expression match. In a simple match, `Select-String` searches the input for the text in the Pattern parameter. It doesn't interpret the value of the Pattern parameter as a regular expression statement.\n" + "description": "Indicates that the cmdlet uses a simple match rather than a regular expression match. In a simple match, `Select-String` searches the input for the text in the Pattern parameter. It doesn't interpret the value of the Pattern parameter as a regular expression statement." }, { "name": [ @@ -332,11 +3010,11 @@ "args": [ { "name": "-Pattern", - "description": "Specifies the text to find on each line. The pattern value is treated as a regular expression.\n" + "description": "Specifies the text to find on each line. The pattern value is treated as a regular expression. The parameter accepts multiple patterns in an array. If you specify more than one pattern, `Select-String` returns matches for each pattern." }, { "name": "-Path", - "description": "Specifies the path to the files to search. Wildcards are permitted. The default location is the local directory.\n" + "description": "Specifies the path to the files to search. Wildcards are permitted. The default location is the local directory." } ], "description": "Finds text in strings and files.", diff --git a/command-signatures/json/autogenerated/powershell/select-xml.json b/command-signatures/json/autogenerated/powershell/select-xml.json index 0c50e76a..dcbc4331 100644 --- a/command-signatures/json/autogenerated/powershell/select-xml.json +++ b/command-signatures/json/autogenerated/powershell/select-xml.json @@ -23,7 +23,7 @@ } ], "isRequired": true, - "description": "Specifies the paths and file names of the XML files to search. Unlike Path , the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + "description": "Specifies the paths and file names of the XML files to search. Unlike Path, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Namespace", @@ -32,7 +32,7 @@ "name": "System.Collections.Hashtable" } ], - "description": "Specifies a hash table of the namespaces used in the XML. Use the format`@{ = }`.\n" + "description": "Specifies a hash table of the namespaces used in the XML. Use the format`@{ = }`." }, { "name": "-Path", @@ -55,7 +55,7 @@ } ], "isRequired": true, - "description": "Specifies one or more XML nodes.\n" + "description": "Specifies one or more XML nodes." }, { "name": "-XPath", diff --git a/command-signatures/json/autogenerated/powershell/send-dtcdiagnostictransaction.json b/command-signatures/json/autogenerated/powershell/send-dtcdiagnostictransaction.json new file mode 100644 index 00000000..aa9632c9 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/send-dtcdiagnostictransaction.json @@ -0,0 +1,244 @@ +{ + "name": "Send-DtcDiagnosticTransaction", + "options": [ + { + "name": "-ComputerName", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Port", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-PropagationMethod", + "args": [ + { + "name": "DtcTransactionPropagation", + "suggestions": [ + { + "name": "Pull" + }, + { + "name": "Push" + } + ] + } + ] + }, + { + "name": "-Transaction", + "args": [ + { + "name": "DtcDiagnosticTransaction" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Transaction" + }, + { + "name": "-ComputerName" + }, + { + "name": "-Port" + }, + { + "name": "-PropagationMethod", + "suggestions": [ + { + "name": "Pull" + }, + { + "name": "Push" + } + ] + } + ], + "description": "Send-DtcDiagnosticTransaction [-Transaction] [[-ComputerName] ] [[-Port] ] [[-PropagationMethod] ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/send-mailmessage.json b/command-signatures/json/autogenerated/powershell/send-mailmessage.json index fa24c683..7d983fb8 100644 --- a/command-signatures/json/autogenerated/powershell/send-mailmessage.json +++ b/command-signatures/json/autogenerated/powershell/send-mailmessage.json @@ -51,11 +51,10 @@ "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to perform this action. The default is the current user.\n" + "description": "Specifies a user account that has permission to perform this action. The default is the current user." }, { "name": [ @@ -67,24 +66,24 @@ "name": "System.Net.Mail.DeliveryNotificationOptions", "suggestions": [ { - "name": "None" + "name": "Delay" }, { - "name": "OnSuccess" + "name": "Never" }, { - "name": "OnFailure" + "name": "None" }, { - "name": "Delay" + "name": "OnFailure" }, { - "name": "Never" + "name": "OnSuccess" } ] } ], - "description": "Specifies the delivery notification options for the email message. You can specify multiple values. None is the default value. The alias for this parameter is DNO .\n" + "description": "Specifies the delivery notification options for the email message. You can specify multiple values. None is the default value. The alias for this parameter is DNO." }, { "name": [ @@ -96,40 +95,42 @@ "name": "System.Text.Encoding", "suggestions": [ { - "name": "ASCII" + "name": "ansi" + }, + { + "name": "ascii" }, { - "name": "BigEndianUnicode" + "name": "bigendianunicode" }, { - "name": "BigEndianUTF32" + "name": "bigendianutf32" }, { - "name": "OEM" + "name": "oem" }, { - "name": "Unicode" + "name": "unicode" }, { - "name": "UTF7" + "name": "utf32" }, { - "name": "UTF8" + "name": "utf7" }, { - "name": "UTF8BOM" + "name": "utf8" }, { - "name": "UTF8NoBOM" + "name": "utf8BOM" }, { - "name": "UTF32" + "name": "utf8NoBOM" } - ], - "default": "ASCII" + ] } ], - "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`.\n" + "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`." }, { "name": "-From", @@ -145,8 +146,7 @@ "name": "-Port", "args": [ { - "name": "System.Int32", - "default": "25" + "name": "System.Int32" } ], "description": "Specifies an alternate port on the SMTP server. The default value is 25, which is the default SMTP port." @@ -157,17 +157,16 @@ { "name": "System.Net.Mail.MailPriority", "suggestions": [ - { - "name": "Normal" - }, { "name": "High" }, { "name": "Low" + }, + { + "name": "Normal" } - ], - "default": "Normal" + ] } ], "description": "Specifies the priority of the email message. Normal is the default. The acceptable values for this parameter are Normal, High, and Low." @@ -179,7 +178,7 @@ "name": "System.String[]" } ], - "description": "Specifies additional email addresses (other than the From address) to use to reply to this message. Enter names (optional) and the email address, such as `Name `.\n" + "description": "Specifies additional email addresses (other than the From address) to use to reply to this message. Enter names (optional) and the email address, such as `Name `." }, { "name": [ @@ -188,11 +187,10 @@ ], "args": [ { - "name": "System.String", - "default": "$PSEmailServer" + "name": "System.String" } ], - "description": "Specifies the name of the SMTP server that sends the email message.\n" + "description": "Specifies the name of the SMTP server that sends the email message." }, { "name": [ @@ -406,7 +404,7 @@ }, { "name": "-SmtpServer", - "description": "Specifies the name of the SMTP server that sends the email message.\n" + "description": "Specifies the name of the SMTP server that sends the email message." } ], "description": "Sends an email message.", diff --git a/command-signatures/json/autogenerated/powershell/set-acl.json b/command-signatures/json/autogenerated/powershell/set-acl.json new file mode 100644 index 00000000..e4d983d5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-acl.json @@ -0,0 +1,283 @@ +{ + "name": "Set-Acl", + "options": [ + { + "name": "-AclObject", + "args": [ + { + "name": "System.Object" + } + ], + "isRequired": true, + "description": "Specifies an ACL with the desired property values. `Set-Acl` changes the ACL of item specified by the Path or InputObject parameter to match the values in the specified security object." + }, + { + "name": "-ClearCentralAccessPolicy", + "description": "Removes the central access policy from the specified item." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Exclude", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Omits the specified items. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcards are permitted." + }, + { + "name": "-Filter", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a filter in the provider's format or language. The value of this parameter qualifies the Path parameter. The syntax of the filter, including the use of wildcards, depends on the provider. Filters are more efficient than other parameters, because the provider applies them when retrieving the objects, rather than having PowerShell filter the objects after they are retrieved." + }, + { + "name": "-Include", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Changes only the specified items. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcards are permitted." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "System.Management.Automation.PSObject" + } + ], + "isRequired": true, + "description": "Changes the security descriptor of the specified object. Enter a variable that contains the object or a command that gets the object." + }, + { + "name": [ + "-LiteralPath", + "-PSPath", + "-LP" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Changes the security descriptor of the specified item. Unlike Path, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks (`'`). Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + }, + { + "name": "-PassThru", + "description": "Returns an object that represents the security descriptor that was changed. By default, this cmdlet does not generate any output." + }, + { + "name": "-Path", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Changes the security descriptor of the specified item. Enter the path to an item, such as a path to a file or registry key. Wildcards are permitted." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Path" + }, + { + "name": "-AclObject", + "description": "Specifies an ACL with the desired property values. `Set-Acl` changes the ACL of item specified by the Path or InputObject parameter to match the values in the specified security object." + } + ], + "description": "Changes the security descriptor of a specified item, such as a file or a registry key.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-alias.json b/command-signatures/json/autogenerated/powershell/set-alias.json index 7d155594..d18255ab 100644 --- a/command-signatures/json/autogenerated/powershell/set-alias.json +++ b/command-signatures/json/autogenerated/powershell/set-alias.json @@ -1,6 +1,13 @@ { "name": "Set-Alias", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Description", "args": [ @@ -12,7 +19,7 @@ }, { "name": "-Force", - "description": "Use the Force parameter to change or delete an alias that has the Option parameter set to ReadOnly .\n" + "description": "Use the Force parameter to change or delete an alias that has the Option parameter set to ReadOnly." }, { "name": "-Name", @@ -51,7 +58,7 @@ ] } ], - "description": "Sets the Option property value of the alias. Values such as `ReadOnly` and `Constant` protect an alias from unintended changes. To see the Option property of all aliases in the session, type `Get-Alias | Format-Table -Property Name, Options -Autosize`.\n" + "description": "Sets the Option property value of the alias. Values such as `ReadOnly` and `Constant` protect an alias from unintended changes. To see the Option property of all aliases in the session, type `Get-Alias | Format-Table -Property Name, Options -AutoSize`." }, { "name": "-PassThru", @@ -61,28 +68,10 @@ "name": "-Scope", "args": [ { - "name": "System.String", - "suggestions": [ - { - "name": "Global" - }, - { - "name": "Local" - }, - { - "name": "Private" - }, - { - "name": "Numbered scopes" - }, - { - "name": "Script" - } - ], - "default": "Local" + "name": "System.String" } ], - "description": "Specifies the scope this alias is valid in. The default value is Local . For more information, see about_Scopes (../Microsoft.PowerShell.Core/About/about_Scopes.md).\n" + "description": "Specifies the scope this alias is valid in. The default value is Local. For more information, see [about_Scopes](../Microsoft.PowerShell.Core/About/about_Scopes.md)." }, { "name": "-Value", @@ -94,13 +83,6 @@ "isRequired": true, "description": "Specifies the name of the cmdlet or command that the alias runs. The Value parameter is the alias's Definition property." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/set-appbackgroundtaskresourcepolicy.json b/command-signatures/json/autogenerated/powershell/set-appbackgroundtaskresourcepolicy.json new file mode 100644 index 00000000..980d74ef --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-appbackgroundtaskresourcepolicy.json @@ -0,0 +1,214 @@ +{ + "name": "Set-AppBackgroundTaskResourcePolicy", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Mode", + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "Conservative" + }, + { + "name": "Normal" + } + ] + } + ], + "isRequired": true, + "description": "Specifies the global pool settings for background tasks on the system. Valid values are Normal and Conservative. Use Normal to enable the global pool for all applications. Use Conservative to disable the global pool for all applications." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Configures the use of the global pool by background tasks.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-appxdefaultvolume.json b/command-signatures/json/autogenerated/powershell/set-appxdefaultvolume.json new file mode 100644 index 00000000..cb677baa --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-appxdefaultvolume.json @@ -0,0 +1,207 @@ +{ + "name": "Set-AppxDefaultVolume", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Volume", + "args": [ + { + "name": "AppxVolume" + } + ], + "isRequired": true + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Set-AppxDefaultVolume [-Volume] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-appxpackageautoupdatesettings.json b/command-signatures/json/autogenerated/powershell/set-appxpackageautoupdatesettings.json new file mode 100644 index 00000000..1f3ac6bd --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-appxpackageautoupdatesettings.json @@ -0,0 +1,334 @@ +{ + "name": "Set-AppxPackageAutoUpdateSettings", + "options": [ + { + "name": "-AllUsers" + }, + { + "name": "-AppInstallerUri", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-CheckOnLaunch", + "args": [ + { + "name": "bool" + } + ] + }, + { + "name": "-ClearPreviousSettings", + "isRequired": true + }, + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-DependencyPackages", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-DisableAutoRepairs", + "args": [ + { + "name": "bool" + } + ] + }, + { + "name": "-EnableAutomaticBackgroundTask", + "args": [ + { + "name": "bool" + } + ] + }, + { + "name": "-ForceUpdateFromAnyVersion", + "args": [ + { + "name": "bool" + } + ] + }, + { + "name": "-HoursBetweenUpdateChecks", + "args": [ + { + "name": "uint" + } + ] + }, + { + "name": "-HoursToPause", + "args": [ + { + "name": "uint" + } + ], + "isRequired": true + }, + { + "name": "-OptionalPackages", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-PackageFamilyName", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-PauseUpdates", + "isRequired": true + }, + { + "name": "-RepairUris", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-ShowPrompt", + "args": [ + { + "name": "bool" + } + ] + }, + { + "name": "-UpdateBlocksActivation", + "args": [ + { + "name": "bool" + } + ] + }, + { + "name": "-UpdateUris", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-UseSystemPolicySource" + }, + { + "name": "-Version", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-PackageFamilyName" + } + ], + "description": "Set-AppxPackageAutoUpdateSettings [-PackageFamilyName] [-AppInstallerUri ] [-UpdateUris ] [-RepairUris ] [-OptionalPackages ] [-DependencyPackages ] [-EnableAutomaticBackgroundTask ] [-ForceUpdateFromAnyVersion ] [-DisableAutoRepairs ] [-CheckOnLaunch ] [-ShowPrompt ] [-UpdateBlocksActivation ] [-UseSystemPolicySource] [-AllUsers] [-HoursBetweenUpdateChecks ] [-Version ] [-WhatIf] [-Confirm] [] Set-AppxPackageAutoUpdateSettings [-PackageFamilyName] -AppInstallerUri -ClearPreviousSettings [-UpdateUris ] [-RepairUris ] [-OptionalPackages ] [-DependencyPackages ] [-EnableAutomaticBackgroundTask ] [-ForceUpdateFromAnyVersion ] [-DisableAutoRepairs ] [-CheckOnLaunch ] [-ShowPrompt ] [-UpdateBlocksActivation ] [-UseSystemPolicySource] [-AllUsers] [-HoursBetweenUpdateChecks ] [-Version ] [-WhatIf] [-Confirm] [] Set-AppxPackageAutoUpdateSettings [-PackageFamilyName] -PauseUpdates -HoursToPause [-UseSystemPolicySource] [-AllUsers] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-appxprovisioneddatafile.json b/command-signatures/json/autogenerated/powershell/set-appxprovisioneddatafile.json new file mode 100644 index 00000000..84d73544 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-appxprovisioneddatafile.json @@ -0,0 +1,282 @@ +{ + "name": "Set-AppXProvisionedDataFile", + "options": [ + { + "name": "-CustomDataPath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies an optional custom data file for an app. You can specify any file name. The file will be renamed to Custom.dat when it is added to the image. If a Custom.dat file already exists, it will be overwritten." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-PackageName", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the name of a package in the Windows image." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Adds custom data into the specified app (.appx) package that has been provisioned in a Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-authenticodesignature.json b/command-signatures/json/autogenerated/powershell/set-authenticodesignature.json new file mode 100644 index 00000000..3a2eba22 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-authenticodesignature.json @@ -0,0 +1,296 @@ +{ + "name": "Set-AuthenticodeSignature", + "options": [ + { + "name": "-Certificate", + "args": [ + { + "name": "System.Security.Cryptography.X509Certificates.X509Certificate2" + } + ], + "isRequired": true, + "description": "Specifies the certificate that will be used to sign the script or file. Enter a variable that stores an object representing the certificate or an expression that gets the certificate." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Content", + "args": [ + { + "name": "System.Byte[]" + } + ], + "isRequired": true, + "description": "This parameter appears in the syntax listing because it's defined in the base class that `Set-AuthenticodeSignature` is derived from. However, support for this parameter isn't implemented in `Set-AuthenticodeSignature`." + }, + { + "name": "-FilePath", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the path to a file that's being signed." + }, + { + "name": "-Force", + "description": "Allows the cmdlet to append a signature to a read-only file. Even using the Force parameter, the cmdlet can't override security restrictions." + }, + { + "name": "-HashAlgorithm", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the hashing algorithm that Windows uses to compute the digital signature for the file." + }, + { + "name": "-IncludeChain", + "args": [ + { + "name": "System.String", + "suggestions": [ + { + "name": "all" + }, + { + "name": "notroot" + }, + { + "name": "signer" + } + ] + } + ], + "description": "Determines which certificates in the certificate trust chain are included in the digital signature. NotRoot is the default." + }, + { + "name": [ + "-LiteralPath", + "-PSPath", + "-LP" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the path to a file that's being signed. Unlike FilePath, the value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + }, + { + "name": "-SourcePathOrExtension", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "This parameter appears in the syntax listing because it's defined in the base class that `Set-AuthenticodeSignature` is derived from. However, support for this parameter isn't implemented in `Set-AuthenticodeSignature`." + }, + { + "name": "-TimestampServer", + "args": [ + { + "name": "System.String" + } + ], + "description": "Uses the specified time stamp server to add a time stamp to the signature. Type the URL of the time stamp server as a string. The URL must start with `http://`." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Certificate-Or-FilePath" + } + ], + "description": "Adds an Authenticode signature to a PowerShell script or other file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-bcdbootdefault.json b/command-signatures/json/autogenerated/powershell/set-bcdbootdefault.json new file mode 100644 index 00000000..e8c5463b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-bcdbootdefault.json @@ -0,0 +1,240 @@ +{ + "name": "Set-BcdBootDefault", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-bcdbootdisplayorder.json b/command-signatures/json/autogenerated/powershell/set-bcdbootdisplayorder.json new file mode 100644 index 00000000..6c378512 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-bcdbootdisplayorder.json @@ -0,0 +1,255 @@ +{ + "name": "Set-BcdBootDisplayOrder", + "options": [ + { + "name": "-AddFirst", + "isRequired": true, + "description": "{{ Fill AddFirst Description }}" + }, + { + "name": "-AddLast", + "isRequired": true, + "description": "{{ Fill AddLast Description }}" + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo[]" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Remove", + "isRequired": true, + "description": "{{ Fill Remove Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-bcdbootsequence.json b/command-signatures/json/autogenerated/powershell/set-bcdbootsequence.json new file mode 100644 index 00000000..0d51ecc7 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-bcdbootsequence.json @@ -0,0 +1,255 @@ +{ + "name": "Set-BcdBootSequence", + "options": [ + { + "name": "-AddFirst", + "isRequired": true, + "description": "{{ Fill AddFirst Description }}" + }, + { + "name": "-AddLast", + "isRequired": true, + "description": "{{ Fill AddLast Description }}" + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo[]" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Remove", + "isRequired": true, + "description": "{{ Fill Remove Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-bcdboottimeout.json b/command-signatures/json/autogenerated/powershell/set-bcdboottimeout.json new file mode 100644 index 00000000..26f69c93 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-bcdboottimeout.json @@ -0,0 +1,228 @@ +{ + "name": "Set-BcdBootTimeout", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": "-Value", + "args": [ + { + "name": "System.Int64" + } + ], + "isRequired": true, + "description": "{{ Fill Value Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Value", + "description": "{{ Fill Value Description }}" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-bcdboottoolsdisplayorder.json b/command-signatures/json/autogenerated/powershell/set-bcdboottoolsdisplayorder.json new file mode 100644 index 00000000..5b500709 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-bcdboottoolsdisplayorder.json @@ -0,0 +1,255 @@ +{ + "name": "Set-BcdBootToolsDisplayOrder", + "options": [ + { + "name": "-AddFirst", + "isRequired": true, + "description": "{{ Fill AddFirst Description }}" + }, + { + "name": "-AddLast", + "isRequired": true, + "description": "{{ Fill AddLast Description }}" + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo[]" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Remove", + "isRequired": true, + "description": "{{ Fill Remove Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-bcddebugsettings.json b/command-signatures/json/autogenerated/powershell/set-bcddebugsettings.json new file mode 100644 index 00000000..b07f2aeb --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-bcddebugsettings.json @@ -0,0 +1,328 @@ +{ + "name": "Set-BcdDebugSettings", + "options": [ + { + "name": "-Baudrate", + "args": [ + { + "name": "System.Int64" + } + ], + "description": "{{ Fill Baudrate Description }}" + }, + { + "name": "-Channel", + "args": [ + { + "name": "System.Int64" + } + ], + "isRequired": true, + "description": "{{ Fill Channel Description }}" + }, + { + "name": "-DebugPort", + "args": [ + { + "name": "System.Int64" + } + ], + "isRequired": true, + "description": "{{ Fill DebugPort Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": "-HostIp", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill HostIp Description }}" + }, + { + "name": "-Ieee1394", + "isRequired": true, + "description": "{{ Fill Ieee1394 Description }}" + }, + { + "name": "-Key", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Key Description }}" + }, + { + "name": "-Local", + "isRequired": true, + "description": "{{ Fill Local Description }}" + }, + { + "name": "-Net", + "isRequired": true, + "description": "{{ Fill Net Description }}" + }, + { + "name": "-NewKey", + "description": "{{ Fill NewKey Description }}" + }, + { + "name": "-NoDhcp", + "description": "{{ Fill NoDhcp Description }}" + }, + { + "name": [ + "-NoUserModeExceptions", + "-NoUmex" + ], + "description": "{{ Fill NoUserModeExceptions Description }}" + }, + { + "name": "-Port", + "args": [ + { + "name": "System.Int64" + } + ], + "isRequired": true, + "description": "{{ Fill Port Description }}" + }, + { + "name": "-Serial", + "isRequired": true, + "description": "{{ Fill Serial Description }}" + }, + { + "name": "-StartPolicy", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.StartPolicy", + "suggestions": [ + { + "name": "Active" + }, + { + "name": "AutoEnable" + }, + { + "name": "Disable" + } + ] + } + ], + "description": "{{ Fill StartPolicy Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": "-TargetName", + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill TargetName Description }}" + }, + { + "name": "-Usb", + "isRequired": true, + "description": "{{ Fill Usb Description }}" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-bcdelement.json b/command-signatures/json/autogenerated/powershell/set-bcdelement.json new file mode 100644 index 00000000..2e813b68 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-bcdelement.json @@ -0,0 +1,316 @@ +{ + "name": "Set-BcdElement", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Device", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.SetBcdElementCommand+DeviceType", + "suggestions": [ + { + "name": "Boot" + }, + { + "name": "File" + }, + { + "name": "Locate" + }, + { + "name": "Partition" + }, + { + "name": "Ramdisk" + }, + { + "name": "URI" + }, + { + "name": "VHD" + } + ] + } + ], + "isRequired": true, + "description": "{{ Fill Device Description }}" + }, + { + "name": "-Element", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Element Description }}" + }, + { + "name": "-Entry", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdEntryInfo" + } + ], + "isRequired": true, + "description": "{{ Fill Entry Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": [ + "-Id", + "-Identifier" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill Id Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": "-Type", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.SetBcdElementCommand+ElementType", + "suggestions": [ + { + "name": "Boolean" + }, + { + "name": "Entry" + }, + { + "name": "EntryList" + }, + { + "name": "Integer" + }, + { + "name": "IntegerList" + }, + { + "name": "String" + } + ] + } + ], + "isRequired": true, + "description": "{{ Fill Type Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Element", + "description": "{{ Fill Element Description }}" + }, + { + "name": "-Entry-Or-Id" + }, + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-bcdhypervisorsettings.json b/command-signatures/json/autogenerated/powershell/set-bcdhypervisorsettings.json new file mode 100644 index 00000000..36354f09 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-bcdhypervisorsettings.json @@ -0,0 +1,277 @@ +{ + "name": "Set-BcdHypervisorSettings", + "options": [ + { + "name": "-Baudrate", + "args": [ + { + "name": "System.Int64" + } + ], + "description": "{{ Fill Baudrate Description }}" + }, + { + "name": "-Channel", + "args": [ + { + "name": "System.Int64" + } + ], + "description": "{{ Fill Channel Description }}" + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-DebugPort", + "args": [ + { + "name": "System.Int64" + } + ], + "isRequired": true, + "description": "{{ Fill DebugPort Description }}" + }, + { + "name": "-Force", + "description": "{{ Fill Force Description }}" + }, + { + "name": "-HostIp", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill HostIp Description }}" + }, + { + "name": "-Ieee1394", + "isRequired": true, + "description": "{{ Fill Ieee1394 Description }}" + }, + { + "name": "-Net", + "isRequired": true, + "description": "{{ Fill Net Description }}" + }, + { + "name": "-Port", + "args": [ + { + "name": "System.Int64" + } + ], + "isRequired": true, + "description": "{{ Fill Port Description }}" + }, + { + "name": "-Serial", + "isRequired": true, + "description": "{{ Fill Serial Description }}" + }, + { + "name": "-Store", + "args": [ + { + "name": "Microsoft.Windows.Bcd.Cmdlets.BcdExtensions.BcdStoreInfo" + } + ], + "description": "{{ Fill Store Description }}" + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Store", + "description": "{{ Fill Store Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-bitstransfer.json b/command-signatures/json/autogenerated/powershell/set-bitstransfer.json new file mode 100644 index 00000000..14ba5bab --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-bitstransfer.json @@ -0,0 +1,624 @@ +{ + "name": "Set-BitsTransfer", + "options": [ + { + "name": "-ACLFlags", + "args": [ + { + "name": "ACLFlagValue" + } + ], + "description": "Specifies the owner and access control list (ACL) information to maintain for the transfer job. Specify one or more of the following values:" + }, + { + "name": [ + "-Authentication", + "-au" + ], + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "Digest" + }, + { + "name": "Negotiate" + }, + { + "name": "Ntlm" + }, + { + "name": "Passport" + } + ] + } + ], + "description": "Specifies the authentication mechanism to be used at the server. The acceptable values for this parameter are:" + }, + { + "name": [ + "-BitsJob", + "-b" + ], + "args": [ + { + "name": "BitsJob[]" + } + ], + "isRequired": true, + "description": "Specifies an array of BITS transfer jobs on which this cmdlet sets properties. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as Get-BitsTransfer" + }, + { + "name": "-CertHash", + "args": [ + { + "name": "Byte[]" + } + ], + "description": "Specifies a SHA1 hash that identifies the certificate." + }, + { + "name": "-CertStoreLocation", + "args": [ + { + "name": "CertStoreLocationValue", + "suggestions": [ + { + "name": "CurrentService" + }, + { + "name": "CurrentUser" + }, + { + "name": "CurrentUserGroupPolicy" + }, + { + "name": "LocalMachine" + }, + { + "name": "LocalMachineEnterprise" + }, + { + "name": "LocalMachineGroupPolicy" + }, + { + "name": "Services" + }, + { + "name": "Users" + } + ] + } + ], + "description": "Specifies the certificate store location to use for to look up the certificate. Valid values are:" + }, + { + "name": "-CertStoreName", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of the certificate store. Valid values are:" + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-Credential", + "-cred" + ], + "args": [ + { + "name": "PSCredential" + } + ], + "description": "Specifies the credentials to use to authenticate the user at the server. The default is the current user. Type a user name, such as \"User01\", \"Domain01\\User01\", or \"User@Contoso.com\". Or, use the Get-Credential cmdlet to create the value for this parameter. When you type a user name, you are prompted for a password." + }, + { + "name": "-CustomHeaders", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies one or more custom HTTP headers to include in the request to the server. Specify an array of strings." + }, + { + "name": "-CustomHeadersWriteOnly", + "description": "Indicates that the HTTP custom headers for this job are write-only." + }, + { + "name": [ + "-Description", + "-d" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a description for the BITS transfer job. The description is limited to 1,024 characters." + }, + { + "name": [ + "-DisplayName", + "-dn" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a display name for the BITS transfer job. The display name provides a user-friendly way to differentiate BITS transfer jobs." + }, + { + "name": "-Dynamic", + "description": "Indicates that the transfer uses the dynamic setting." + }, + { + "name": [ + "-HttpMethod", + "-hm" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a method for the transfer other than the default method GET. If you specify GET, the parameter has no effect." + }, + { + "name": "-MaxDownloadTime", + "args": [ + { + "name": "Int32" + } + ], + "description": "Specifies the maximum time, in seconds, for transferring the files in a job. The default is 7,776,000 seconds or 90 days." + }, + { + "name": "-NotifyCmdLine", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies a program to run after the job finishes or encounters an error. The program runs in the context of the user who runs this cmdlet." + }, + { + "name": "-NotifyFlags", + "args": [ + { + "name": "NotifyFlagValue" + } + ], + "description": "Specifies the type of event notification you want to receive, such as job transferred events. Valid values are:" + }, + { + "name": [ + "-Priority", + "-p" + ], + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "Foreground" + }, + { + "name": "High" + }, + { + "name": "Low" + }, + { + "name": "Normal" + } + ] + } + ], + "description": "Specifies the priority of the BITS transfer job, which affects bandwidth usage. The acceptable values for this parameter are:" + }, + { + "name": [ + "-ProxyAuthentication", + "-pa" + ], + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "Digest" + }, + { + "name": "Negotiate" + }, + { + "name": "Ntlm" + }, + { + "name": "Passport" + } + ] + } + ], + "description": "Specifies the authentication mechanism to use at the Web proxy. The acceptable values for this parameter are:" + }, + { + "name": [ + "-ProxyBypass", + "-pb" + ], + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies a list of host names to use for a direct connection. The hosts in the list are tried in order until a successful connection is achieved. If you specify this parameter the cmdlet bypasses the proxy. If this parameter is used, the *ProxyUsage* parameter must be set to Override; otherwise, an error occurs." + }, + { + "name": [ + "-ProxyCredential", + "-pc" + ], + "args": [ + { + "name": "PSCredential" + } + ], + "description": "Specifies the credentials to use to authenticate the user at the proxy. You can use the Get-Credential cmdlet to create a value for this parameter." + }, + { + "name": [ + "-ProxyList", + "-pl" + ], + "args": [ + { + "name": "Uri[]" + } + ], + "description": "Specifies an array of proxies to use. The proxies in the list are tried in order until a successful connection is achieved. If this parameter is specified and *ProxyUsage* is set to a value other than Override, an error occurs." + }, + { + "name": [ + "-ProxyUsage", + "-pu" + ], + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "AutoDetect" + }, + { + "name": "NoProxy" + }, + { + "name": "Override" + }, + { + "name": "SystemDefault" + } + ] + } + ], + "description": "Specifies the proxy usage settings. The acceptable values for this parameter are:" + }, + { + "name": "-RetryInterval", + "args": [ + { + "name": "Int32" + } + ], + "description": "Specifies the minimum length of time, in seconds, that BITS waits before it attempts to transfer the file after BITS encounters a transient error. The minimum allowed value is 60 seconds. If this value exceeds the RetryTimeout value from the BitsJob object, BITS will not retry the transfer. Instead, BITS sets the state of the BITS transfer job to the Error state." + }, + { + "name": "-RetryTimeout", + "args": [ + { + "name": "Int32" + } + ], + "description": "Specifies the length of time, in seconds, that BITS attempts to transfer the file after the first transient error occurs. Setting the retry period to 0 prevents retries. If the retry period value exceeds the JobInactivityTimeout Group Policy setting (90-day default), BITS cancels the job." + }, + { + "name": "-SecurityFlags", + "args": [ + { + "name": "SecurityFlagValue" + } + ], + "description": "Specifies security flags for the HTTP request." + }, + { + "name": [ + "-SetOwnerToCurrentUser", + "-so" + ], + "description": "Indicates that the cmdlet sets the owner of the BITS transfer job to the current user." + }, + { + "name": "-TransferPolicy", + "args": [ + { + "name": "CostStates", + "suggestions": [ + { + "name": "Always" + }, + { + "name": "BelowCap" + }, + { + "name": "Capped" + }, + { + "name": "IgnoreCongestion" + }, + { + "name": "NearCap" + }, + { + "name": "None" + }, + { + "name": "NoSurcharge" + }, + { + "name": "NotRoaming" + }, + { + "name": "OverCapCharged" + }, + { + "name": "OverCapThrottled" + }, + { + "name": "PolicyUnrestricted" + }, + { + "name": "Roaming" + }, + { + "name": "Standard" + }, + { + "name": "Unrestricted" + }, + { + "name": "UsageBased" + } + ] + } + ], + "description": "Specifies the network cost states in which the transfer is allowed to be scheduled. The current cost state of the network is a bitmask that indicates the kinds of charges that would be incurred if a transfer was scheduled at this time. This cost state represents a bitmask; if the bit corresponding to the current network cost state is set, the transfer can be scheduled. If the bit corresponding to the current network cost state is not set, the transfer is ignored for scheduling purposes. You can submit any of the named values listed here, or add them together to provide a custom value." + }, + { + "name": "-UseStoredCredential", + "args": [ + { + "name": "AuthenticationTargetValue", + "suggestions": [ + { + "name": "None" + }, + { + "name": "Proxy" + }, + { + "name": "Server" + } + ] + } + ], + "description": "Specifies that credentials stored in the Windows Credential Manager should be used for authentication when required for the specified target server type. If this parameter is not specified and a server requires authentication, then explicit credentials must be included by using the *Credential* or *ProxyCredential* parameters. This parameter is a flag parameter whose values can be added together to create the desired behavior." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-BitsJob", + "description": "Specifies an array of BITS transfer jobs on which this cmdlet sets properties. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as Get-BitsTransfer" + } + ], + "description": "Modifies the properties of an existing BITS transfer job.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-certificateautoenrollmentpolicy.json b/command-signatures/json/autogenerated/powershell/set-certificateautoenrollmentpolicy.json new file mode 100644 index 00000000..f53840b5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-certificateautoenrollmentpolicy.json @@ -0,0 +1,270 @@ +{ + "name": "Set-CertificateAutoEnrollmentPolicy", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-EnableAll", + "isRequired": true, + "description": "Enables all of the auto-enrollment policy settings and sets the value for the expiration percentage to 10 percent. If this parameter is enabled, then only the Context parameter is required and all other parameters are optional." + }, + { + "name": "-EnableBalloonNotifications", + "description": "Enables the Expiration balloon notifications option for the certificate auto-enrollment policy." + }, + { + "name": "-EnableMyStoreManagement", + "description": "Enables the Renew expired certificates, update pending certificates, and remove revoked certificates option for the certificate auto-enrollment policy." + }, + { + "name": "-EnableTemplateCheck", + "description": "Verifies that existing certificates are based on the most recent version of a certificate template and updates them if they are not." + }, + { + "name": "-ExpirationPercentage", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Sets the percentage of the certificate lifetime at which close-to-expiration events are logged and auto-enrollment notifications start to appear." + }, + { + "name": "-PolicyState", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.PolicySetting", + "suggestions": [ + { + "name": "NotConfigured" + }, + { + "name": "Enabled" + }, + { + "name": "Disabled" + } + ] + } + ], + "isRequired": true, + "description": "Specifies the state of the certificate auto-enrollment policy configuration." + }, + { + "name": "-StoreName", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies additional comma separated certificate stores to monitor for certificates that have expired or are expiring. The MY store is always monitored." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": "-Context", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.Context", + "suggestions": [ + { + "name": "Machine" + }, + { + "name": "User" + } + ] + } + ], + "isRequired": true, + "description": "Specifies whether to set certificate auto-enrollment policy for the user or computer context." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Sets local certificate auto-enrollment policy.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-ciminstance.json b/command-signatures/json/autogenerated/powershell/set-ciminstance.json new file mode 100644 index 00000000..f2a3390c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-ciminstance.json @@ -0,0 +1,302 @@ +{ + "name": "Set-CimInstance", + "options": [ + { + "name": "-CimSession", + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimSession[]" + } + ], + "isRequired": true, + "description": "Runs the cmdlets on a remote computer. Enter a computer name or a session object, such as the output of a `New-CimSession` or `Get-CimSession` cmdlet." + }, + { + "name": [ + "-ComputerName", + "-CN", + "-ServerName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies the name of the computer on which you want to run the CIM operation. You can specify a fully qualified domain name (FQDN) or a NetBIOS name." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-InputObject", + "-CimInstance" + ], + "args": [ + { + "name": "Microsoft.Management.Infrastructure.CimInstance" + } + ], + "isRequired": true, + "description": "Specifies a CIM instance object to use as input." + }, + { + "name": "-Namespace", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the namespace for the CIM operation. The default namespace is root/CIMV2. You can use tab completion to browse the list of namespaces, because PowerShell gets a list of namespaces from the local WMI server to provide the list of namespaces." + }, + { + "name": [ + "-OperationTimeoutSec", + "-OT" + ], + "args": [ + { + "name": "System.UInt32" + } + ], + "description": "Specifies the amount of time that the cmdlet waits for a response from the computer. By default, the value of this parameter is 0, which means that the cmdlet uses the default timeout value for the server." + }, + { + "name": "-PassThru", + "description": "Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output." + }, + { + "name": [ + "-Property", + "-Arguments" + ], + "args": [ + { + "name": "System.Collections.IDictionary" + } + ], + "isRequired": true, + "description": "Specifies the properties of the CIM instance as a hash table (using name-value pairs). Only the properties specified using this parameter are changed. Other properties of the CIM instance are not changed." + }, + { + "name": "-Query", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies a query to run on the CIM server to retrieve CIM instances on which to run the cmdlet. You can specify the query dialect using the QueryDialect parameter." + }, + { + "name": "-QueryDialect", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the query language used for the Query parameter. The acceptable values for this parameter are: WQL or CQL. The default value is WQL." + }, + { + "name": "-ResourceUri", + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the resource uniform resource identifier (URI) of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Query" + } + ], + "description": "Modifies a CIM instance on a CIM server by calling the ModifyInstance method of the CIM class.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-clipboard.json b/command-signatures/json/autogenerated/powershell/set-clipboard.json index 22b59016..fe2c1222 100644 --- a/command-signatures/json/autogenerated/powershell/set-clipboard.json +++ b/command-signatures/json/autogenerated/powershell/set-clipboard.json @@ -5,6 +5,20 @@ "name": "-Append", "description": "Indicates that the cmdlet should add to the clipboard instead of replacing it. By default, the cmdlet clears the current content from the clipboard and sets it to the new content. When this parameter is specified, the cmdlet appends the new content after a newline to the current content." }, + { + "name": [ + "-AsOSC52", + "-ToLocalhost" + ], + "description": "When connected to a remote session over SSH, `Set-Clipboard` sets the clipboard of the remote machine, not the local host. When you use this parameter, `Set-Clipboard` uses the OSC52 ANSI escape sequence to set the clipboard of the local machine." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-PassThru", "description": "Returns an object representing the item with which you're working. By default, this cmdlet does not generate any output." @@ -19,13 +33,6 @@ "isRequired": true, "description": "The string values to be added to the clipboard." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/set-content.json b/command-signatures/json/autogenerated/powershell/set-content.json index 802a21db..ae61868e 100644 --- a/command-signatures/json/autogenerated/powershell/set-content.json +++ b/command-signatures/json/autogenerated/powershell/set-content.json @@ -3,7 +3,14 @@ "options": [ { "name": "-AsByteStream", - "description": "This is a dynamic parameter made available by the FileSystem provider. For more information, see about_FileSystem_Provider (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md).\n" + "description": "This is a dynamic parameter made available by the FileSystem provider. For more information, see [about_FileSystem_Provider](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-Credential", @@ -11,7 +18,8 @@ { "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Encoding", @@ -20,40 +28,42 @@ "name": "System.Text.Encoding", "suggestions": [ { - "name": "ASCII" + "name": "ansi" + }, + { + "name": "ascii" }, { - "name": "BigEndianUnicode" + "name": "bigendianunicode" }, { - "name": "BigEndianUTF32" + "name": "bigendianutf32" }, { - "name": "OEM" + "name": "oem" }, { - "name": "Unicode" + "name": "unicode" }, { - "name": "UTF7" + "name": "utf32" }, { - "name": "UTF8" + "name": "utf7" }, { - "name": "UTF8BOM" + "name": "utf8" }, { - "name": "UTF8NoBOM" + "name": "utf8BOM" }, { - "name": "UTF32" + "name": "utf8NoBOM" } - ], - "default": "utf8NoBOM" + ] } ], - "description": "This is a dynamic parameter made available by the FileSystem provider. For more information, see about_FileSystem_Provider (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md).\n" + "description": "This is a dynamic parameter made available by the FileSystem provider. For more information, see [about_FileSystem_Provider](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)." }, { "name": "-Exclude", @@ -62,7 +72,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -71,11 +81,11 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Force", - "description": "Forces the cmdlet to set the contents of a file, even if the file is read-only. Implementation varies from provider to provider. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md). The Force parameter does not override security restrictions." + "description": "Forces the cmdlet to set the contents of a file, even if the file is read-only. Implementation varies from provider to provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md). The Force parameter does not override security restrictions." }, { "name": "-Include", @@ -84,7 +94,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -98,11 +108,11 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-NoNewline", - "description": "This is a dynamic parameter made available by the FileSystem provider. For more information, see about_FileSystem_Provider (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md).\n" + "description": "This is a dynamic parameter made available by the FileSystem provider. For more information, see [about_FileSystem_Provider](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)." }, { "name": "-PassThru", @@ -125,7 +135,7 @@ "name": "System.String" } ], - "description": "This is a dynamic parameter made available by the FileSystem provider. This Parameter is only available on Windows. For more information, see about_FileSystem_Provider (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md).\n" + "description": "This is a dynamic parameter made available by the FileSystem provider. This Parameter is only available on Windows. For more information, see [about_FileSystem_Provider](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)." }, { "name": "-Value", @@ -137,13 +147,6 @@ "isRequired": true, "description": "Specifies the new content for the item." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/set-culture.json b/command-signatures/json/autogenerated/powershell/set-culture.json new file mode 100644 index 00000000..847745ce --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-culture.json @@ -0,0 +1,197 @@ +{ + "name": "Set-Culture", + "options": [ + { + "name": "-CultureInfo", + "args": [ + { + "name": "CultureInfo" + } + ], + "isRequired": true, + "description": "Specifies a culture." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-CultureInfo", + "description": "Specifies a culture." + } + ], + "description": "Sets the user culture for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-date.json b/command-signatures/json/autogenerated/powershell/set-date.json index 760c1297..de9caed5 100644 --- a/command-signatures/json/autogenerated/powershell/set-date.json +++ b/command-signatures/json/autogenerated/powershell/set-date.json @@ -9,7 +9,14 @@ } ], "isRequired": true, - "description": "Specifies the value for which this cmdlet adds or subtracts from the current date and time. can type an adjustment in standard date and time format for your locale or use the Adjust parameter to pass a TimeSpan object from `New-TimeSpan` to `Set-Date`." + "description": "Specifies the value for which this cmdlet adds or subtracts from the current date and time. You can type an adjustment in standard date and time format for your locale or use the Adjust parameter to pass a TimeSpan object from `New-TimeSpan` to `Set-Date`." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-Date", @@ -19,7 +26,7 @@ } ], "isRequired": true, - "description": "Changes the date and time to the specified values. You can type a new date in the short date format and a time in the standard time format for your locale. Or, you can pass a DateTime object from `Get-Date`.\n" + "description": "Changes the date and time to the specified values. You can type a new date in the short date format and a time in the standard time format for your locale. Or, you can pass a DateTime object from `Get-Date`." }, { "name": "-DisplayHint", @@ -31,29 +38,22 @@ "name": "Date" }, { - "name": "Time" + "name": "DateTime" }, { - "name": "DateTime" + "name": "Time" } ] } ], - "description": "Specifies which elements of the date and time are displayed.The acceptable values for this parameter are:\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies which elements of the date and time are displayed. The acceptable values for this parameter are:" }, { "name": [ "-WhatIf", "-wi" ], - "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/set-executionpolicy.json b/command-signatures/json/autogenerated/powershell/set-executionpolicy.json index ec6ceba9..14680879 100644 --- a/command-signatures/json/autogenerated/powershell/set-executionpolicy.json +++ b/command-signatures/json/autogenerated/powershell/set-executionpolicy.json @@ -1,6 +1,13 @@ { "name": "Set-ExecutionPolicy", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-ExecutionPolicy", "args": [ @@ -32,7 +39,7 @@ } ], "isRequired": true, - "description": "Specifies the execution policy. If there are no Group Policies and each scope's execution policy is set to `Undefined`, then `Restricted` becomes the effective policy for all users.\n" + "description": "Specifies the execution policy. If there are no Group Policies and each scope's execution policy is set to `Undefined`, then `Restricted` becomes the effective policy for all users." }, { "name": "-Force", @@ -59,18 +66,10 @@ { "name": "UserPolicy" } - ], - "default": "LocalMachine" + ] } ], - "description": "Specifies the scope that is affected by an execution policy. The default scope is `LocalMachine`.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the scope that is affected by an execution policy. The default scope is `LocalMachine`." }, { "name": [ @@ -253,7 +252,7 @@ "args": [ { "name": "-ExecutionPolicy", - "description": "Specifies the execution policy. If there are no Group Policies and each scope's execution policy is set to `Undefined`, then `Restricted` becomes the effective policy for all users.\n", + "description": "Specifies the execution policy. If there are no Group Policies and each scope's execution policy is set to `Undefined`, then `Restricted` becomes the effective policy for all users.", "suggestions": [ { "name": "AllSigned" @@ -280,7 +279,7 @@ }, { "name": "-Scope", - "description": "Specifies the scope that is affected by an execution policy. The default scope is `LocalMachine`.\n", + "description": "Specifies the scope that is affected by an execution policy. The default scope is `LocalMachine`.", "suggestions": [ { "name": "CurrentUser" diff --git a/command-signatures/json/autogenerated/powershell/set-item.json b/command-signatures/json/autogenerated/powershell/set-item.json index df6f3999..e3580f47 100644 --- a/command-signatures/json/autogenerated/powershell/set-item.json +++ b/command-signatures/json/autogenerated/powershell/set-item.json @@ -1,14 +1,21 @@ { "name": "Set-Item", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Exclude", @@ -17,7 +24,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -26,11 +33,11 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Force", - "description": "Forces the cmdlet to set items that cannot otherwise be changed, such as read-only alias or variables. The cmdlet cannot change constant aliases or variables. Implementation varies from provider to provider. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md). Even using the Force parameter, the cmdlet cannot override security restrictions." + "description": "Forces the cmdlet to set items that cannot otherwise be changed, such as read-only alias or variables. The cmdlet cannot change constant aliases or variables. Implementation varies from provider to provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md). Even using the *Force* parameter, the cmdlet cannot override security restrictions." }, { "name": "-Include", @@ -39,7 +46,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": [ @@ -53,7 +60,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Options", @@ -62,7 +69,7 @@ "name": "System.Management.Automation.ScopedItemOptions" } ], - "description": "This is a dynamic parameter made available by the Alias and Function providers. For more information, see about_Alias_Provider (../Microsoft.PowerShell.Core/About/about_Alias_Provider.md)and about_Function_Provider (../Microsoft.PowerShell.Core/About/about_Function_Provider.md).\n" + "description": "This is a dynamic parameter made available by the Alias and Function providers. For more information, see [about_Alias_Provider](../Microsoft.PowerShell.Core/About/about_Alias_Provider.md) and [about_Function_Provider](../Microsoft.PowerShell.Core/About/about_Function_Provider.md)." }, { "name": "-PassThru", @@ -85,7 +92,7 @@ "name": "Microsoft.Win32.RegistryValueKind" } ], - "description": "This is a dynamic parameter made available by the Registry provider. The Registry provider and this parameter are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the Registry provider. The Registry provider and this parameter are only available on Windows." }, { "name": "-Value", @@ -96,13 +103,6 @@ ], "description": "Specifies a new value for the item." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/set-itemproperty.json b/command-signatures/json/autogenerated/powershell/set-itemproperty.json index a11ce13b..2bf65b76 100644 --- a/command-signatures/json/autogenerated/powershell/set-itemproperty.json +++ b/command-signatures/json/autogenerated/powershell/set-itemproperty.json @@ -1,14 +1,21 @@ { "name": "Set-ItemProperty", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter is not supported by any providers installed with PowerShell. > To impersonate another user, or elevate your credentials when running this cmdlet, > use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Exclude", @@ -17,7 +24,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as ` .txt`. Wildcard characters are permitted. The Exclude * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `*.txt`. Wildcard characters are permitted. The Exclude parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-Filter", @@ -26,11 +33,11 @@ "name": "System.String" } ], - "description": "Specifies a filter to qualify the Path parameter. The FileSystem (../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards (../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." + "description": "Specifies a filter to qualify the Path parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved." }, { "name": "-Force", - "description": "Forces the cmdlet to set a property on items that cannot otherwise be accessed by the user. Implementation varies by provider. For more information, see about_Providers (../Microsoft.PowerShell.Core/About/about_Providers.md)." + "description": "Forces the cmdlet to set a property on items that cannot otherwise be accessed by the user. Implementation varies by provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md)." }, { "name": "-Include", @@ -39,7 +46,7 @@ "name": "System.String[]" } ], - "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\" .txt\"`. Wildcard characters are permitted. The Include * parameter is effective only when the command includes the contents of an item, such as `C:\\Windows*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." + "description": "Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as `\"*.txt\"`. Wildcard characters are permitted. The Include parameter is effective only when the command includes the contents of an item, such as `C:\\Windows\\*`, where the wildcard character specifies the contents of the `C:\\Windows` directory." }, { "name": "-InputObject", @@ -63,7 +70,7 @@ } ], "isRequired": true, - "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.\n" + "description": "Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": [ @@ -99,7 +106,7 @@ "name": "Microsoft.Win32.RegistryValueKind" } ], - "description": "This is a dynamic parameter made available by the Registry provider. The Registry provider and this parameter are only available on Windows.\n" + "description": "This is a dynamic parameter made available by the Registry provider. The Registry provider and this parameter are only available on Windows." }, { "name": "-Value", @@ -111,13 +118,6 @@ "isRequired": true, "description": "Specifies the value of the property." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/set-jobtrigger.json b/command-signatures/json/autogenerated/powershell/set-jobtrigger.json new file mode 100644 index 00000000..830e9a3e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-jobtrigger.json @@ -0,0 +1,182 @@ +{ + "name": "Set-JobTrigger", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Set-JobTrigger", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-kdsconfiguration.json b/command-signatures/json/autogenerated/powershell/set-kdsconfiguration.json new file mode 100644 index 00000000..b1af77b7 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-kdsconfiguration.json @@ -0,0 +1,274 @@ +{ + "name": "Set-KdsConfiguration", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "KdsServerConfiguration" + } + ], + "isRequired": true, + "description": "Specifies the server configuration object that contains the configuration information of the Microsoft Group KdsSvc." + }, + { + "name": "-KdfAlgorithm", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of the key derivation function algorithm that the key distribution server uses to generate the keys." + }, + { + "name": "-KdfParameters", + "args": [ + { + "name": "Byte[]" + } + ], + "description": "Specifies the parameters for the key derivation function used to generate the group private key. If this parameter is not specified or this parameter is set to $Null, then no key derivation function parameters are needed." + }, + { + "name": "-LocalTestOnly", + "description": "Indicates that the cmdlet only validates the new group key distribution service configuration on the local computer, and does not store the key in Active Directory." + }, + { + "name": "-RevertToDefault", + "isRequired": true, + "description": "Indicates that the customized service configuration is reverted to the default configuration." + }, + { + "name": "-SecretAgreementAlgorithm", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of the secret agreement algorithm used to generate a group public key." + }, + { + "name": "-SecretAgreementParameters", + "args": [ + { + "name": "Byte[]" + } + ], + "description": "Specifies the parameters for the secret agreement algorithm. If this parameter is not specified or this parameter is set to $Null, then no secret agreement algorithm parameters are needed." + }, + { + "name": "-SecretAgreementPrivateKeyLength", + "args": [ + { + "name": "Int32" + } + ], + "description": "Specifies the length of the private key used in the secret agreement algorithm." + }, + { + "name": "-SecretAgreementPublicKeyLength", + "args": [ + { + "name": "Int32" + } + ], + "description": "Specifies the length of the public key used in the secret agreement algorithm." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject", + "description": "Specifies the server configuration object that contains the configuration information of the Microsoft Group KdsSvc." + } + ], + "description": "Sets the configuration of Microsoft Group KdsSvc.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-lapsadauditing.json b/command-signatures/json/autogenerated/powershell/set-lapsadauditing.json new file mode 100644 index 00000000..f5c49595 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-lapsadauditing.json @@ -0,0 +1,263 @@ +{ + "name": "Set-LapsADAuditing", + "options": [ + { + "name": "-AuditedPrincipals", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the name of the users or groups should be configured for auditing. Users or groups may be specified in either name or SID format. If specified in name format, the name must always include the identifying domain name portion unless the name maps to a well-known or built-in account." + }, + { + "name": "-AuditType", + "args": [ + { + "name": "System.Security.AccessControl.AuditFlags", + "suggestions": [ + { + "name": "Failure" + }, + { + "name": "None" + }, + { + "name": "Success" + } + ] + } + ], + "description": "Specifies whether to configure Success or Failure auditing." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies the credentials to use when updating AD. If not specified, the current user's credentials are used." + }, + { + "name": "-Domain", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the domain to connect to." + }, + { + "name": "-DomainController", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the domain controller to connect to." + }, + { + "name": "-Identity", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the name of the OU to update." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Configures an Active Directory (AD) Organizational Unit (OU) to enable auditing on the Windows Local Administrator Password Solution (LAPS) password schema attributes.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-lapsadcomputerselfpermission.json b/command-signatures/json/autogenerated/powershell/set-lapsadcomputerselfpermission.json new file mode 100644 index 00000000..1d0f815a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-lapsadcomputerselfpermission.json @@ -0,0 +1,233 @@ +{ + "name": "Set-LapsADComputerSelfPermission", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies the credentials to use when updating AD. If not specified, the current user's credentials are used." + }, + { + "name": "-Domain", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the domain to connect to." + }, + { + "name": "-DomainController", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the domain controller to connect to." + }, + { + "name": "-Identity", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the name of the OU to update." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Configures permissions on an Active Directory (AD) Organizational Unit (OU) to enable computers in that OU to update their Windows Local Administrator Password Solution (LAPS) passwords.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-lapsadpasswordexpirationtime.json b/command-signatures/json/autogenerated/powershell/set-lapsadpasswordexpirationtime.json new file mode 100644 index 00000000..e85e5b00 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-lapsadpasswordexpirationtime.json @@ -0,0 +1,228 @@ +{ + "name": "Set-LapsADPasswordExpirationTime", + "options": [ + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies the credentials to use when updating AD. If not specified, the current user's credentials are used." + }, + { + "name": "-Domain", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the domain to connect to." + }, + { + "name": "-DomainController", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the domain controller to connect to." + }, + { + "name": "-Identity", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the name of the computer or domain controller object to set the LAPS password expiration time on." + }, + { + "name": "-WhenEffective", + "args": [ + { + "name": "System.DateTime" + } + ], + "description": "Specifies the new LAPS password expiration time. If not specified, the current time is used, which expires the password is immediately." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Sets the Windows Local Administrator Password Solution (LAPS) password expiration timestamp on an Active Directory (AD) computer or domain controller object.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-lapsadreadpasswordpermission.json b/command-signatures/json/autogenerated/powershell/set-lapsadreadpasswordpermission.json new file mode 100644 index 00000000..12e46132 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-lapsadreadpasswordpermission.json @@ -0,0 +1,243 @@ +{ + "name": "Set-LapsADReadPasswordPermission", + "options": [ + { + "name": "-AllowedPrincipals", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the name of the users or groups should be granted the permissions. Users or groups may be specified in either name or SID format. If specified in name format, the name must always include the identifying domain name portion unless the name maps to a well-known or built-in account." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies the credentials to use when updating AD. If not specified, the current user's credentials are used." + }, + { + "name": "-Domain", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the domain to connect to." + }, + { + "name": "-DomainController", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the domain controller to connect to." + }, + { + "name": "-Identity", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the name of the OU to update." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or groups permission to query Windows Local Administrator Password Solution (LAPS) passwords.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-lapsadresetpasswordpermission.json b/command-signatures/json/autogenerated/powershell/set-lapsadresetpasswordpermission.json new file mode 100644 index 00000000..12675c92 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-lapsadresetpasswordpermission.json @@ -0,0 +1,243 @@ +{ + "name": "Set-LapsADResetPasswordPermission", + "options": [ + { + "name": "-AllowedPrincipals", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the name of the users or groups should be granted the permissions. Users or groups may be specified in either name or SID format. If specified in name format, the name must always include the identifying domain name portion unless the name maps to a well-known or built-in account." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies the credentials to use when updating AD. If not specified, the current user's credentials are used." + }, + { + "name": "-Domain", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the domain to connect to." + }, + { + "name": "-DomainController", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the name of the domain controller to connect to." + }, + { + "name": "-Identity", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the name of the OU to update." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or groups permission to set the Windows Local Administrator Password Solution (LAPS) password expiration time.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-localgroup.json b/command-signatures/json/autogenerated/powershell/set-localgroup.json new file mode 100644 index 00000000..92f7468c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-localgroup.json @@ -0,0 +1,240 @@ +{ + "name": "Set-LocalGroup", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Description", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies a comment for the group. The maximum length is 48 characters." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.LocalGroup" + } + ], + "isRequired": true, + "description": "Specifies the security group that this cmdlet changes. To obtain a security group, use the Get-LocalGroup cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the security group that this cmdlet changes." + }, + { + "name": "-SID", + "args": [ + { + "name": "System.Security.Principal.SecurityIdentifier" + } + ], + "isRequired": true, + "description": "Specifies the security ID (SID) of the security group that this cmdlet changes." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name-Or-SID" + } + ], + "description": "Changes a local security group.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-localuser.json b/command-signatures/json/autogenerated/powershell/set-localuser.json new file mode 100644 index 00000000..413689c9 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-localuser.json @@ -0,0 +1,288 @@ +{ + "name": "Set-LocalUser", + "options": [ + { + "name": "-AccountExpires", + "args": [ + { + "name": "System.DateTime" + } + ], + "description": "Specifies when the user account expires. To obtain a DateTime object, use the `Get-Date` cmdlet." + }, + { + "name": "-AccountNeverExpires", + "description": "Indicates that the account does not expire." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Description", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a comment for the user account. The maximum length is 48 characters." + }, + { + "name": "-FullName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the full name for the user account. The full name differs from the user name of the user account." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "Microsoft.PowerShell.Commands.LocalUser" + } + ], + "isRequired": true, + "description": "Specifies the user account that this cmdlet changes. To obtain a user account, use the `Get-LocalUser` cmdlet." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the user account that this cmdlet changes." + }, + { + "name": "-Password", + "args": [ + { + "name": "System.Security.SecureString" + } + ], + "description": "Specifies a password for the user account. If the user account is connected to a Microsoft account, do not set a password." + }, + { + "name": "-PasswordNeverExpires", + "args": [ + { + "name": "System.Boolean" + } + ], + "description": "Indicates whether the password expires." + }, + { + "name": "-SID", + "args": [ + { + "name": "System.Security.Principal.SecurityIdentifier" + } + ], + "isRequired": true, + "description": "Specifies the security ID (SID) of the user account that this cmdlet changes." + }, + { + "name": "-UserMayChangePassword", + "args": [ + { + "name": "System.Boolean" + } + ], + "description": "Indicates that the user can change the password on the user account." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name-Or-SID" + } + ], + "description": "Modifies a local user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-location.json b/command-signatures/json/autogenerated/powershell/set-location.json index e54f9ab4..f0b53a73 100644 --- a/command-signatures/json/autogenerated/powershell/set-location.json +++ b/command-signatures/json/autogenerated/powershell/set-location.json @@ -28,7 +28,7 @@ "template": "folders" } ], - "description": "Specify the path of a new working location. If no path is provided, `Set-Location` defaults to the current user's home directory. When wildcards are used, the cmdlet chooses the container (directory, registry key, certificate store) that matches the wildcard pattern. If the wildcard pattern matches more than one container, the cmdlet returns an error.\n" + "description": "Specify the path of a new working location. If no path is provided, `Set-Location` defaults to the current user's home directory. When wildcards are used, the cmdlet chooses the container (directory, registry key, certificate store) that matches the wildcard pattern. If the wildcard pattern matches more than one container, the cmdlet returns an error." }, { "name": "-StackName", @@ -37,7 +37,7 @@ "name": "System.String" } ], - "description": "Specifies an existing location stack name that this cmdlet makes the current location stack. Enter a location stack name. To indicate the unnamed default location stack, type `$null` or an empty string (`\"\"`).\n" + "description": "Specifies an existing location stack name that this cmdlet makes the current location stack. Enter a location stack name. To indicate the unnamed default location stack, type `$null` or an empty string (`\"\"`)." }, { "name": [ @@ -213,7 +213,7 @@ "args": [ { "name": "-Path", - "description": "Specify the path of a new working location. If no path is provided, `Set-Location` defaults to the current user's home directory. When wildcards are used, the cmdlet chooses the container (directory, registry key, certificate store) that matches the wildcard pattern. If the wildcard pattern matches more than one container, the cmdlet returns an error.\n", + "description": "Specify the path of a new working location. If no path is provided, `Set-Location` defaults to the current user's home directory. When wildcards are used, the cmdlet chooses the container (directory, registry key, certificate store) that matches the wildcard pattern. If the wildcard pattern matches more than one container, the cmdlet returns an error.", "template": "folders" } ], diff --git a/command-signatures/json/autogenerated/powershell/set-markdownoption.json b/command-signatures/json/autogenerated/powershell/set-markdownoption.json index 72027d8b..2a9590d3 100644 --- a/command-signatures/json/autogenerated/powershell/set-markdownoption.json +++ b/command-signatures/json/autogenerated/powershell/set-markdownoption.json @@ -130,7 +130,7 @@ } ], "isRequired": true, - "description": "Selects a theme containing predefined color settings. The possible values are Dark and Light ." + "description": "Selects a theme containing predefined color settings. The possible values are Dark and Light." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/set-nonremovableappspolicy.json b/command-signatures/json/autogenerated/powershell/set-nonremovableappspolicy.json new file mode 100644 index 00000000..70696f8f --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-nonremovableappspolicy.json @@ -0,0 +1,282 @@ +{ + "name": "Set-NonRemovableAppsPolicy", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-NonRemovable", + "args": [ + { + "name": "Int32" + } + ], + "isRequired": true, + "description": "Configures an app package as removable or non-removable." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-PackageFamilyName", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the Package Family Name of the app package to set as non-removable." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Sets an app package as non-removable (can not be uninstalled).", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-osconfigurationdocument.json b/command-signatures/json/autogenerated/powershell/set-osconfigurationdocument.json new file mode 100644 index 00000000..749a587d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-osconfigurationdocument.json @@ -0,0 +1,246 @@ +{ + "name": "Set-OsConfigurationDocument", + "options": [ + { + "name": "-Content", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Content Description }}" + }, + { + "name": [ + "-FriendlyName", + "-FNAME" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill FriendlyName Description }}" + }, + { + "name": [ + "-SourceId", + "-SID" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill SourceId Description }}" + }, + { + "name": "-TimeoutInSeconds", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "{{ Fill TimeoutInSeconds Description }}" + }, + { + "name": "-Wait", + "description": "{{ Fill Wait Description }}" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Content", + "description": "{{ Fill Content Description }}" + }, + { + "name": "-SourceId", + "description": "{{ Fill SourceId Description }}" + }, + { + "name": "-FriendlyName", + "description": "{{ Fill FriendlyName Description }}" + }, + { + "name": "-TimeoutInSeconds", + "description": "{{ Fill TimeoutInSeconds Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-osconfigurationproperty.json b/command-signatures/json/autogenerated/powershell/set-osconfigurationproperty.json new file mode 100644 index 00000000..38493c60 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-osconfigurationproperty.json @@ -0,0 +1,265 @@ +{ + "name": "Set-OsConfigurationProperty", + "options": [ + { + "name": [ + "-FriendlyName", + "-FNAME" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill FriendlyName Description }}" + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String", + "suggestions": [ + { + "name": "AlwaysRefresh" + }, + { + "name": "DriftControl" + }, + { + "name": "RefreshPeriod" + } + ] + } + ], + "isRequired": true, + "description": "{{ Fill Name Description }}" + }, + { + "name": [ + "-SourceId", + "-SID" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "{{ Fill SourceId Description }}" + }, + { + "name": "-Value", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "{{ Fill Value Description }}" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "{{ Fill Name Description }}", + "suggestions": [ + { + "name": "AlwaysRefresh" + }, + { + "name": "DriftControl" + }, + { + "name": "RefreshPeriod" + } + ] + }, + { + "name": "-Value", + "description": "{{ Fill Value Description }}" + }, + { + "name": "-SourceId", + "description": "{{ Fill SourceId Description }}" + }, + { + "name": "-FriendlyName", + "description": "{{ Fill FriendlyName Description }}" + } + ], + "description": "{{ Fill in the Synopsis }}", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-osconfigurationscenariodefinition.json b/command-signatures/json/autogenerated/powershell/set-osconfigurationscenariodefinition.json new file mode 100644 index 00000000..6312bb27 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-osconfigurationscenariodefinition.json @@ -0,0 +1,238 @@ +{ + "name": "Set-OsConfigurationScenarioDefinition", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Content", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-Force" + }, + { + "name": [ + "-FriendlyName", + "-FNAME" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-SourceId", + "-SID" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Content" + }, + { + "name": "-SourceId" + }, + { + "name": "-FriendlyName" + } + ], + "description": "Set-OsConfigurationScenarioDefinition [-Content] [[-SourceId] ] [[-FriendlyName] ] [-Force] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-processmitigation.json b/command-signatures/json/autogenerated/powershell/set-processmitigation.json new file mode 100644 index 00000000..f60ba136 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-processmitigation.json @@ -0,0 +1,606 @@ +{ + "name": "Set-ProcessMitigation", + "options": [ + { + "name": [ + "-Disable", + "-d" + ], + "args": [ + { + "name": "String[]", + "suggestions": [ + { + "name": "AllowStoreSignedBinaries" + }, + { + "name": "AllowThreadsToOptOut" + }, + { + "name": "AuditChildProcess" + }, + { + "name": "AuditDynamicCode" + }, + { + "name": "AuditEnableExportAddressFilter" + }, + { + "name": "AuditEnableExportAddressFilterPlus" + }, + { + "name": "AuditEnableImportAddressFilter" + }, + { + "name": "AuditEnableRopCallerCheck" + }, + { + "name": "AuditEnableRopSimExec" + }, + { + "name": "AuditEnableRopStackPivot" + }, + { + "name": "AuditFont" + }, + { + "name": "AuditFsctlSystemCall" + }, + { + "name": "AuditLowLabelImageLoads" + }, + { + "name": "AuditMicrosoftSigned" + }, + { + "name": "AuditPreferSystem32" + }, + { + "name": "AuditRemoteImageLoads" + }, + { + "name": "AuditSEHOP" + }, + { + "name": "AuditStoreSigned" + }, + { + "name": "AuditSystemCall" + }, + { + "name": "AuditUserShadowStack" + }, + { + "name": "BlockDynamicCode" + }, + { + "name": "BlockLowLabelImageLoads" + }, + { + "name": "BlockRemoteImageLoads" + }, + { + "name": "BottomUp" + }, + { + "name": "CFG" + }, + { + "name": "DEP" + }, + { + "name": "DisableExtensionPoints" + }, + { + "name": "DisableFsctlSystemCalls" + }, + { + "name": "DisableNonSystemFonts" + }, + { + "name": "DisableWin32kSystemCalls" + }, + { + "name": "DisallowChildProcessCreation" + }, + { + "name": "EmulateAtlThunks" + }, + { + "name": "EnableExportAddressFilter" + }, + { + "name": "EnableExportAddressFilterPlus" + }, + { + "name": "EnableImportAddressFilter" + }, + { + "name": "EnableRopCallerCheck" + }, + { + "name": "EnableRopSimExec" + }, + { + "name": "EnableRopStackPivot" + }, + { + "name": "EnforceModuleDependencySigning" + }, + { + "name": "ForceRelocateImages" + }, + { + "name": "HighEntropy" + }, + { + "name": "MicrosoftSignedOnly" + }, + { + "name": "PreferSystem32" + }, + { + "name": "RequireInfo" + }, + { + "name": "SEHOP" + }, + { + "name": "SEHOPTelemetry" + }, + { + "name": "StrictCFG" + }, + { + "name": "StrictHandle" + }, + { + "name": "SuppressExports" + }, + { + "name": "TerminateOnError" + }, + { + "name": "UserShadowStack" + }, + { + "name": "UserShadowStackStrictMode" + } + ] + } + ], + "description": "Comma separated list of mitigations to disable. Disable list takes priority over enable list. If specified in both, it will be disabled." + }, + { + "name": "-EAFModules", + "args": [ + { + "name": "String[]" + } + ], + "description": "Modules to be added to the EAF+ mitigation." + }, + { + "name": [ + "-Enable", + "-e" + ], + "args": [ + { + "name": "String[]", + "suggestions": [ + { + "name": "AllowStoreSignedBinaries" + }, + { + "name": "AllowThreadsToOptOut" + }, + { + "name": "AuditChildProcess" + }, + { + "name": "AuditDynamicCode" + }, + { + "name": "AuditEnableExportAddressFilter" + }, + { + "name": "AuditEnableExportAddressFilterPlus" + }, + { + "name": "AuditEnableImportAddressFilter" + }, + { + "name": "AuditEnableRopCallerCheck" + }, + { + "name": "AuditEnableRopSimExec" + }, + { + "name": "AuditEnableRopStackPivot" + }, + { + "name": "AuditFont" + }, + { + "name": "AuditFsctlSystemCall" + }, + { + "name": "AuditLowLabelImageLoads" + }, + { + "name": "AuditMicrosoftSigned" + }, + { + "name": "AuditPreferSystem32" + }, + { + "name": "AuditRemoteImageLoads" + }, + { + "name": "AuditSEHOP" + }, + { + "name": "AuditStoreSigned" + }, + { + "name": "AuditSystemCall" + }, + { + "name": "AuditUserShadowStack" + }, + { + "name": "BlockDynamicCode" + }, + { + "name": "BlockLowLabelImageLoads" + }, + { + "name": "BlockRemoteImageLoads" + }, + { + "name": "BottomUp" + }, + { + "name": "CFG" + }, + { + "name": "DEP" + }, + { + "name": "DisableExtensionPoints" + }, + { + "name": "DisableFsctlSystemCalls" + }, + { + "name": "DisableNonSystemFonts" + }, + { + "name": "DisableWin32kSystemCalls" + }, + { + "name": "DisallowChildProcessCreation" + }, + { + "name": "EmulateAtlThunks" + }, + { + "name": "EnableExportAddressFilter" + }, + { + "name": "EnableExportAddressFilterPlus" + }, + { + "name": "EnableImportAddressFilter" + }, + { + "name": "EnableRopCallerCheck" + }, + { + "name": "EnableRopSimExec" + }, + { + "name": "EnableRopStackPivot" + }, + { + "name": "EnforceModuleDependencySigning" + }, + { + "name": "ForceRelocateImages" + }, + { + "name": "HighEntropy" + }, + { + "name": "MicrosoftSignedOnly" + }, + { + "name": "PreferSystem32" + }, + { + "name": "RequireInfo" + }, + { + "name": "SEHOP" + }, + { + "name": "SEHOPTelemetry" + }, + { + "name": "StrictCFG" + }, + { + "name": "StrictHandle" + }, + { + "name": "SuppressExports" + }, + { + "name": "TerminateOnError" + }, + { + "name": "UserShadowStack" + }, + { + "name": "UserShadowStackStrictMode" + } + ] + } + ], + "description": "Comma separated list of mitigations to enable. Disable list takes priority over enable list. If specified in both, it will be disabled." + }, + { + "name": [ + "-Force", + "-f" + ], + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "notset" + }, + { + "name": "off" + }, + { + "name": "on" + } + ] + } + ], + "description": "Overrides a system setting either on or off depending on the level this is set at. Will force \"on\"/\"off\" all mitigations provided in the -Enable list" + }, + { + "name": [ + "-IsValid", + "-v" + ], + "description": "Set to check the given XML file for validity. Requires local .xsd" + }, + { + "name": "-Name", + "args": [ + { + "name": "String" + } + ], + "description": "Name of the process to apply mitigation settings to. Can be in the format \"notepad\" or \"notepad.exe\"" + }, + { + "name": [ + "-PolicyFilePath", + "-x" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Path to XML file containing mitigation settings." + }, + { + "name": "-Remove", + "description": "Removes a mitigation entry from the registry." + }, + { + "name": [ + "-Reset", + "-r" + ], + "description": "Resets a specific mitigation entry to defer." + }, + { + "name": [ + "-System", + "-s" + ], + "description": "Used to configure system defaults rather than individual apps." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Name of the process to apply mitigation settings to. Can be in the format \"notepad\" or \"notepad.exe\"" + } + ], + "description": "Commands to enable and disable process mitigations or set them in bulk from an XML file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-psbreakpoint.json b/command-signatures/json/autogenerated/powershell/set-psbreakpoint.json index 0aefe846..49104071 100644 --- a/command-signatures/json/autogenerated/powershell/set-psbreakpoint.json +++ b/command-signatures/json/autogenerated/powershell/set-psbreakpoint.json @@ -8,17 +8,16 @@ "name": "System.Management.Automation.ScriptBlock" } ], - "description": "Specifies commands that run at each breakpoint instead of breaking. Enter a script block that contains the commands. You can use this parameter to set conditional breakpoints or to perform other tasks, such as testing or logging.\n" + "description": "Specifies commands that run at each breakpoint instead of breaking. Enter a scriptblock that contains the commands. You can use this parameter to set conditional breakpoints or to perform other tasks, such as testing or logging." }, { "name": "-Column", "args": [ { - "name": "System.Int32", - "default": "1" + "name": "System.Int32" } ], - "description": "Specifies the column number of the column in the script file on which execution stops. Enter only one column number. The default is column 1.\n" + "description": "Specifies the column number of the column in the script file on which execution stops. Enter only one column number. The default is column 1." }, { "name": [ @@ -31,7 +30,7 @@ } ], "isRequired": true, - "description": "Sets a command breakpoint. Enter cmdlet names, such as `Get-Process`, or function names. Wildcards are permitted.\n" + "description": "Sets a command breakpoint. Enter cmdlet names, such as `Get-Process`, or function names. Wildcards are permitted." }, { "name": "-Line", @@ -41,7 +40,7 @@ } ], "isRequired": true, - "description": "Sets a line breakpoint in a script. Enter one or more line numbers, separated by commas. PowerShell stops immediately before executing the statement that begins on each of the specified lines.\n" + "description": "Sets a line breakpoint in a script. Enter one or more line numbers, separated by commas. PowerShell stops immediately before executing the statement that begins on each of the specified lines." }, { "name": "-Mode", @@ -53,15 +52,15 @@ "name": "Read" }, { - "name": "Write" + "name": "ReadWrite" }, { - "name": "ReadWrite" + "name": "Write" } ] } ], - "description": "Specifies the mode of access that triggers variable breakpoints. The default is Write .\n" + "description": "Specifies the mode of access that triggers variable breakpoints. The default is Write." }, { "name": "-Runspace", @@ -70,7 +69,7 @@ "name": "Runspace" } ], - "description": "Specifies the Id of a Runspace object so you can interact with breakpoints in the specified runspace.\n" + "description": "Specifies the Id of a Runspace object so you can interact with breakpoints in the specified runspace." }, { "name": "-Script", @@ -79,7 +78,8 @@ "name": "System.String[]" } ], - "description": "Specifies an array of script files that this cmdlet sets a breakpoint in. Enter the paths and file names of one or more script files. If the files are in the current directory, you can omit the path. Wildcards are permitted.\n" + "isRequired": true, + "description": "Specifies an array of script files that this cmdlet sets a breakpoint in. Enter the paths and file names of one or more script files. If the files are in the current directory, you can omit the path. Wildcards are permitted." }, { "name": [ @@ -92,7 +92,7 @@ } ], "isRequired": true, - "description": "Specifies an array of variables that this cmdlet sets breakpoints on. Enter a comma-separated list of variables without dollar signs (`$`).\n" + "description": "Specifies an array of variables that this cmdlet sets breakpoints on. Enter a comma-separated list of variables without dollar signs (`$`)." }, { "name": [ @@ -268,15 +268,15 @@ "args": [ { "name": "-Script", - "description": "Specifies an array of script files that this cmdlet sets a breakpoint in. Enter the paths and file names of one or more script files. If the files are in the current directory, you can omit the path. Wildcards are permitted.\n" + "description": "Specifies an array of script files that this cmdlet sets a breakpoint in. Enter the paths and file names of one or more script files. If the files are in the current directory, you can omit the path. Wildcards are permitted." }, { "name": "-Line", - "description": "Sets a line breakpoint in a script. Enter one or more line numbers, separated by commas. PowerShell stops immediately before executing the statement that begins on each of the specified lines.\n" + "description": "Sets a line breakpoint in a script. Enter one or more line numbers, separated by commas. PowerShell stops immediately before executing the statement that begins on each of the specified lines." }, { "name": "-Column", - "description": "Specifies the column number of the column in the script file on which execution stops. Enter only one column number. The default is column 1.\n" + "description": "Specifies the column number of the column in the script file on which execution stops. Enter only one column number. The default is column 1." } ], "description": "Sets a breakpoint on a line, command, or variable.", diff --git a/command-signatures/json/autogenerated/powershell/set-psdebug.json b/command-signatures/json/autogenerated/powershell/set-psdebug.json index d0f3013c..9d7dd503 100644 --- a/command-signatures/json/autogenerated/powershell/set-psdebug.json +++ b/command-signatures/json/autogenerated/powershell/set-psdebug.json @@ -7,11 +7,11 @@ }, { "name": "-Step", - "description": "Turns on script stepping. Before each line runs, PowerShell prompts you to stop, continue, or enter a new interpreter level to inspect the state of the script.\n" + "description": "Turns on script stepping. Before each line runs, PowerShell prompts you to stop, continue, or enter a new interpreter level to inspect the state of the script." }, { "name": "-Strict", - "description": "Specifies that variables must be assigned a value before being referenced in a script. If a variable is referenced before a value is assigned, PowerShell returns an exception error. This is equivalent to `Set-StrictMode -Version 1`. For more information, see Set-StrictMode (Set-StrictMode.md)." + "description": "Specifies that variables must be assigned a value before being referenced in a script. If a variable is referenced before a value is assigned, PowerShell returns an exception error. This is equivalent to `Set-StrictMode -Version 1`. For more information, see [Set-StrictMode](Set-StrictMode.md)." }, { "name": "-Trace", @@ -20,7 +20,7 @@ "name": "System.Int32" } ], - "description": "Specifies the trace level for each line in a script. Each line is traced as it's run.\n" + "description": "Specifies the trace level for each line in a script. Each line is traced as it's run." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/set-psreadlinekeyhandler.json b/command-signatures/json/autogenerated/powershell/set-psreadlinekeyhandler.json index 4c10342c..74a6d556 100644 --- a/command-signatures/json/autogenerated/powershell/set-psreadlinekeyhandler.json +++ b/command-signatures/json/autogenerated/powershell/set-psreadlinekeyhandler.json @@ -5,10 +5,9 @@ "name": "-BriefDescription", "args": [ { - "name": "System.String" + "name": "string" } - ], - "description": "A brief description of the key binding. This description is displayed by the `Get-PSReadLineKeyHandler` cmdlet." + ] }, { "name": [ @@ -17,11 +16,10 @@ ], "args": [ { - "name": "System.String[]" + "name": "string[]" } ], - "isRequired": true, - "description": "The key or sequence of keys to be bound to a function or script block. Use a single string to specify a single binding. If the binding is a sequence of keys, separate the keys by a comma. For example: `Ctrl+x,Ctrl+l`\n" + "isRequired": true }, { "name": [ @@ -30,39 +28,591 @@ ], "args": [ { - "name": "System.String" + "name": "string" } - ], - "description": "Specifies a more detailed description of the key binding that's visible in the output of the `Get-PSReadLineKeyHandler` cmdlet." + ] }, { "name": "-Function", "args": [ { - "name": "System.String" + "name": "string", + "suggestions": [ + { + "name": "Abort" + }, + { + "name": "AcceptAndGetNext" + }, + { + "name": "AcceptLine" + }, + { + "name": "AcceptNextSuggestionWord" + }, + { + "name": "AcceptSuggestion" + }, + { + "name": "AddLine" + }, + { + "name": "BackwardChar" + }, + { + "name": "BackwardDeleteChar" + }, + { + "name": "BackwardDeleteInput" + }, + { + "name": "BackwardDeleteLine" + }, + { + "name": "BackwardDeleteWord" + }, + { + "name": "BackwardKillInput" + }, + { + "name": "BackwardKillLine" + }, + { + "name": "BackwardKillWord" + }, + { + "name": "BackwardWord" + }, + { + "name": "BeginningOfHistory" + }, + { + "name": "BeginningOfLine" + }, + { + "name": "CancelLine" + }, + { + "name": "CapitalizeWord" + }, + { + "name": "CaptureScreen" + }, + { + "name": "CharacterSearch" + }, + { + "name": "CharacterSearchBackward" + }, + { + "name": "ClearHistory" + }, + { + "name": "ClearScreen" + }, + { + "name": "Complete" + }, + { + "name": "Copy" + }, + { + "name": "CopyOrCancelLine" + }, + { + "name": "Cut" + }, + { + "name": "DeleteChar" + }, + { + "name": "DeleteCharOrExit" + }, + { + "name": "DeleteEndOfBuffer" + }, + { + "name": "DeleteEndOfWord" + }, + { + "name": "DeleteLine" + }, + { + "name": "DeleteLineToFirstChar" + }, + { + "name": "DeletePreviousLines" + }, + { + "name": "DeleteToEnd" + }, + { + "name": "DeleteWord" + }, + { + "name": "DigitArgument" + }, + { + "name": "DowncaseWord" + }, + { + "name": "EndOfHistory" + }, + { + "name": "EndOfLine" + }, + { + "name": "ExchangePointAndMark" + }, + { + "name": "ForwardChar" + }, + { + "name": "ForwardDeleteInput" + }, + { + "name": "ForwardDeleteLine" + }, + { + "name": "ForwardSearchHistory" + }, + { + "name": "ForwardWord" + }, + { + "name": "GotoBrace" + }, + { + "name": "GotoColumn" + }, + { + "name": "GotoFirstNonBlankOfLine" + }, + { + "name": "HistorySearchBackward" + }, + { + "name": "HistorySearchForward" + }, + { + "name": "InsertLineAbove" + }, + { + "name": "InsertLineBelow" + }, + { + "name": "InvertCase" + }, + { + "name": "InvokePrompt" + }, + { + "name": "KillLine" + }, + { + "name": "KillRegion" + }, + { + "name": "KillWord" + }, + { + "name": "MenuComplete" + }, + { + "name": "MoveToEndOfLine" + }, + { + "name": "NextHistory" + }, + { + "name": "NextLine" + }, + { + "name": "NextSuggestion" + }, + { + "name": "NextWord" + }, + { + "name": "NextWordEnd" + }, + { + "name": "Paste" + }, + { + "name": "PasteAfter" + }, + { + "name": "PasteBefore" + }, + { + "name": "PossibleCompletions" + }, + { + "name": "PrependAndAccept" + }, + { + "name": "PreviousHistory" + }, + { + "name": "PreviousLine" + }, + { + "name": "PreviousSuggestion" + }, + { + "name": "Redo" + }, + { + "name": "RepeatLastCharSearch" + }, + { + "name": "RepeatLastCharSearchBackwards" + }, + { + "name": "RepeatLastCommand" + }, + { + "name": "RepeatSearch" + }, + { + "name": "RepeatSearchBackward" + }, + { + "name": "ReverseSearchHistory" + }, + { + "name": "RevertLine" + }, + { + "name": "ScrollDisplayDown" + }, + { + "name": "ScrollDisplayDownLine" + }, + { + "name": "ScrollDisplayToCursor" + }, + { + "name": "ScrollDisplayTop" + }, + { + "name": "ScrollDisplayUp" + }, + { + "name": "ScrollDisplayUpLine" + }, + { + "name": "SearchChar" + }, + { + "name": "SearchCharBackward" + }, + { + "name": "SearchCharBackwardWithBackoff" + }, + { + "name": "SearchCharWithBackoff" + }, + { + "name": "SearchForward" + }, + { + "name": "SelectAll" + }, + { + "name": "SelectBackwardChar" + }, + { + "name": "SelectBackwardsLine" + }, + { + "name": "SelectBackwardWord" + }, + { + "name": "SelectCommandArgument" + }, + { + "name": "SelectForwardChar" + }, + { + "name": "SelectForwardWord" + }, + { + "name": "SelectLine" + }, + { + "name": "SelectNextWord" + }, + { + "name": "SelectShellBackwardWord" + }, + { + "name": "SelectShellForwardWord" + }, + { + "name": "SelectShellNextWord" + }, + { + "name": "SelfInsert" + }, + { + "name": "SetMark" + }, + { + "name": "ShellBackwardKillWord" + }, + { + "name": "ShellBackwardWord" + }, + { + "name": "ShellForwardWord" + }, + { + "name": "ShellKillWord" + }, + { + "name": "ShellNextWord" + }, + { + "name": "ShowCommandHelp" + }, + { + "name": "ShowFullPredictionTooltip" + }, + { + "name": "ShowKeyBindings" + }, + { + "name": "ShowParameterHelp" + }, + { + "name": "SwapCharacters" + }, + { + "name": "SwitchPredictionView" + }, + { + "name": "TabCompleteNext" + }, + { + "name": "TabCompletePrevious" + }, + { + "name": "Undo" + }, + { + "name": "UndoAll" + }, + { + "name": "UnixWordRubout" + }, + { + "name": "UpcaseWord" + }, + { + "name": "ValidateAndAcceptLine" + }, + { + "name": "ViAcceptLine" + }, + { + "name": "ViAcceptLineOrExit" + }, + { + "name": "ViAppendLine" + }, + { + "name": "ViBackwardChar" + }, + { + "name": "ViBackwardDeleteGlob" + }, + { + "name": "ViBackwardGlob" + }, + { + "name": "ViBackwardWord" + }, + { + "name": "ViCommandMode" + }, + { + "name": "ViDeleteBrace" + }, + { + "name": "ViDeleteEndOfGlob" + }, + { + "name": "ViDeleteGlob" + }, + { + "name": "ViDeleteToBeforeChar" + }, + { + "name": "ViDeleteToBeforeCharBackward" + }, + { + "name": "ViDeleteToChar" + }, + { + "name": "ViDeleteToCharBackward" + }, + { + "name": "ViDigitArgumentInChord" + }, + { + "name": "ViEditVisually" + }, + { + "name": "ViEndOfGlob" + }, + { + "name": "ViEndOfPreviousGlob" + }, + { + "name": "ViExit" + }, + { + "name": "ViForwardChar" + }, + { + "name": "ViGotoBrace" + }, + { + "name": "ViInsertAtBegining" + }, + { + "name": "ViInsertAtEnd" + }, + { + "name": "ViInsertLine" + }, + { + "name": "ViInsertMode" + }, + { + "name": "ViInsertWithAppend" + }, + { + "name": "ViInsertWithDelete" + }, + { + "name": "ViJoinLines" + }, + { + "name": "ViNextGlob" + }, + { + "name": "ViNextWord" + }, + { + "name": "ViReplaceLine" + }, + { + "name": "ViReplaceToBeforeChar" + }, + { + "name": "ViReplaceToBeforeCharBackward" + }, + { + "name": "ViReplaceToChar" + }, + { + "name": "ViReplaceToCharBackward" + }, + { + "name": "ViSearchHistoryBackward" + }, + { + "name": "ViTabCompleteNext" + }, + { + "name": "ViTabCompletePrevious" + }, + { + "name": "ViYankBeginningOfLine" + }, + { + "name": "ViYankEndOfGlob" + }, + { + "name": "ViYankEndOfWord" + }, + { + "name": "ViYankLeft" + }, + { + "name": "ViYankLine" + }, + { + "name": "ViYankNextGlob" + }, + { + "name": "ViYankNextWord" + }, + { + "name": "ViYankPercent" + }, + { + "name": "ViYankPreviousGlob" + }, + { + "name": "ViYankPreviousWord" + }, + { + "name": "ViYankRight" + }, + { + "name": "ViYankToEndOfLine" + }, + { + "name": "ViYankToFirstChar" + }, + { + "name": "WhatIsKey" + }, + { + "name": "Yank" + }, + { + "name": "YankLastArg" + }, + { + "name": "YankNthArg" + }, + { + "name": "YankPop" + } + ] } ], - "isRequired": true, - "description": "Specifies the name of an existing key handler provided by PSReadLine. This parameter lets you rebind existing key bindings, or bind a handler that's currently unbound." + "isRequired": true }, { "name": "-ScriptBlock", "args": [ { - "name": "System.Management.Automation.ScriptBlock" + "name": "scriptblock" } ], - "isRequired": true, - "description": "Specifies a script block value to run when the chord is entered. PSReadLine passes one or two parameters to this script block. The first parameter is a ConsoleKeyInfo object representing the key pressed. The second argument can be any object depending on the context." + "isRequired": true }, { "name": "-ViMode", "args": [ { - "name": "Microsoft.PowerShell.ViMode" + "name": "ViMode", + "suggestions": [ + { + "name": "Insert" + }, + { + "name": "Command" + } + ] } - ], - "description": "Specify which vi mode the binding applies to.\n" + ] }, { "name": [ @@ -237,14 +787,13 @@ ], "args": [ { - "name": "-Chord", - "description": "The key or sequence of keys to be bound to a function or script block. Use a single string to specify a single binding. If the binding is a sequence of keys, separate the keys by a comma. For example: `Ctrl+x,Ctrl+l`\n" + "name": "-Chord" }, { "name": "-Function-Or-ScriptBlock" } ], - "description": "Binds keys to user-defined or PSReadLine key handler functions.", + "description": "Set-PSReadLineKeyHandler [-Chord] [-ScriptBlock] [-BriefDescription ] [-Description ] [-ViMode ] [] Set-PSReadLineKeyHandler [-Chord] [-Function] [-ViMode ] []", "parserDirectives": { "flagsArePosixNoncompliant": true, "flagsMatchUniquePrefix": true, diff --git a/command-signatures/json/autogenerated/powershell/set-psreadlineoption.json b/command-signatures/json/autogenerated/powershell/set-psreadlineoption.json index 1318a2b6..fcdbfc80 100644 --- a/command-signatures/json/autogenerated/powershell/set-psreadlineoption.json +++ b/command-signatures/json/autogenerated/powershell/set-psreadlineoption.json @@ -5,220 +5,256 @@ "name": "-AddToHistoryHandler", "args": [ { - "name": "System.Func`2[System.String,System.Object]" + "name": "Func[string,Object]" } - ], - "description": "Specifies a ScriptBlock that controls how commands get added to PSReadLine history.\n" + ] }, { "name": "-AnsiEscapeTimeout", "args": [ { - "name": "System.Int32", - "default": "100" + "name": "int" } - ], - "description": "This option is specific to Windows when input is redirected, for example, when running under `tmux` or `screen`.\n" + ] }, { "name": "-BellStyle", "args": [ { - "name": "Microsoft.PowerShell.BellStyle", - "default": "Audible" + "name": "BellStyle", + "suggestions": [ + { + "name": "None" + }, + { + "name": "Visual" + }, + { + "name": "Audible" + } + ] } - ], - "description": "Specifies how PSReadLine responds to various error and ambiguous conditions.\n" + ] }, { "name": "-Colors", "args": [ { - "name": "System.Collections.Hashtable" + "name": "hashtable" } - ], - "description": "The Colors parameter specifies various colors used by PSReadLine .\n" + ] }, { "name": "-CommandValidationHandler", "args": [ { - "name": "System.Action`1[System.Management.Automation.Language.CommandAst]" + "name": "Action[CommandAst]" } - ], - "description": "Specifies a ScriptBlock that is called from ValidateAndAcceptLine . If an exception is thrown, validation fails and the error is reported.\n" + ] }, { "name": "-CompletionQueryItems", "args": [ { - "name": "System.Int32", - "default": "100" + "name": "int" } - ], - "description": "Specifies the maximum number of completion items that are shown without prompting.\n" + ] }, { "name": "-ContinuationPrompt", "args": [ { - "name": "System.String", - "default": ">>" + "name": "string" } - ], - "description": "Specifies the string displayed at the beginning of the subsequent lines when multi-line input is entered. The default is double greater-than signs (`>>`). An empty string is valid." + ] }, { "name": "-DingDuration", "args": [ { - "name": "System.Int32", - "default": "50ms" + "name": "int" } - ], - "description": "Specifies the duration of the beep when BellStyle is set to Audible ." + ] }, { "name": "-DingTone", "args": [ { - "name": "System.Int32", - "default": "1221" + "name": "int" } - ], - "description": "Specifies the tone in Hertz (Hz) of the beep when BellStyle is set to Audible ." + ] }, { "name": "-EditMode", "args": [ { - "name": "Microsoft.PowerShell.EditMode", - "default": "Windows" + "name": "EditMode", + "suggestions": [ + { + "name": "Windows" + }, + { + "name": "Emacs" + }, + { + "name": "Vi" + } + ] } - ], - "description": "Specifies the command line editing mode. Using this parameter resets any key bindings set by `Set-PSReadLineKeyHandler`.\n" + ] + }, + { + "name": "-EnableScreenReaderMode" }, { "name": "-ExtraPromptLineCount", "args": [ { - "name": "System.Int32", - "default": "0" + "name": "int" } - ], - "description": "Specifies the number of extra lines.\n" + ] }, { - "name": "-HistoryNoDuplicates", - "description": "This option controls the recall behavior. Duplicate commands are still added to the history file. When this option is set, only the most recent invocation appears when recalling commands. Repeated commands are added to history to preserve ordering during recall. However, you typically don't want to see the command multiple times when recalling or searching the history.\n" + "name": "-HistoryNoDuplicates" }, { "name": "-HistorySavePath", "args": [ { - "name": "System.String", - "default": "A file named $($Host.Name)_history.txt in $env:APPDATA\\Microsoft\\Windows\\PowerShell\\PSReadLine on Windows and $env:XDG_DATA_HOME/powershell/PSReadLine or $HOME/.local/share/powershell/PSReadLine on non-Windows platforms" + "name": "string" } - ], - "description": "Specifies the path to the file where history is saved. Computers running Windows or non-Windows platforms store the file in different locations. The filename is stored in a variable `$($Host.Name)_history.txt`, for example `ConsoleHost_history.txt`.\n" + ] }, { "name": "-HistorySaveStyle", "args": [ { - "name": "Microsoft.PowerShell.HistorySaveStyle", - "default": "SaveIncrementally" + "name": "HistorySaveStyle", + "suggestions": [ + { + "name": "SaveIncrementally" + }, + { + "name": "SaveAtExit" + }, + { + "name": "SaveNothing" + } + ] } - ], - "description": "Specifies how PSReadLine saves history.\n" + ] }, { - "name": "-HistorySearchCaseSensitive", - "description": "Specifies that history searching is case-sensitive in functions like ReverseSearchHistory or HistorySearchBackward .\n" + "name": "-HistorySearchCaseSensitive" }, { - "name": "-HistorySearchCursorMovesToEnd", - "description": "Indicates that the cursor moves to the end of commands that you load from history by using a search. When this parameter is set to `$False`, the cursor remains at the position it was when you pressed the up or down arrows.\n" + "name": "-HistorySearchCursorMovesToEnd" }, { "name": "-MaximumHistoryCount", "args": [ { - "name": "System.Int32" + "name": "int" } - ], - "description": "Specifies the maximum number of commands to save in PSReadLine history. PSReadLine history is separate from PowerShell history." + ] }, { "name": "-MaximumKillRingCount", "args": [ { - "name": "System.Int32", - "default": "10" + "name": "int" } - ], - "description": "Specifies the maximum number of items stored in the kill ring." + ] }, { "name": "-PredictionSource", "args": [ { - "name": "Microsoft.PowerShell.PredictionSource" + "name": "PredictionSource", + "suggestions": [ + { + "name": "None" + }, + { + "name": "History" + }, + { + "name": "Plugin" + }, + { + "name": "HistoryAndPlugin" + } + ] } - ], - "description": "Specifies the source for PSReadLine to get predictive suggestions.\n" + ] }, { "name": "-PredictionViewStyle", "args": [ { - "name": "Microsoft.PowerShell.PredictionViewStyle", - "default": "InlineView" + "name": "PredictionViewStyle", + "suggestions": [ + { + "name": "InlineView" + }, + { + "name": "ListView" + } + ] } - ], - "description": "Sets the style for the display of the predictive text. The default is InlineView .\n" + ] }, { "name": "-PromptText", "args": [ { - "name": "System.String[]", - "default": ">" + "name": "string[]" } - ], - "description": "This parameter sets the value of the PromptText property. The default value is `\"> \"`. PSReadLine analyzes your prompt function to determine how to change only the color of part of your prompt. This analysis isn't 100% reliable. Use this option if PSReadLine is changing your prompt in unexpected ways. Include any trailing whitespace.\n" + ] }, { - "name": "-ShowToolTips", - "description": "When displaying possible completions, tooltips are shown in the list of completions.\n" + "name": "-ShowToolTips" + }, + { + "name": "-TerminateOrphanedConsoleApps" }, { "name": "-ViModeChangeHandler", "args": [ { - "name": "System.Management.Automation.ScriptBlock" + "name": "scriptblock" } - ], - "description": "When the ViModeIndicator is set to `Script`, the script block provided will be invoked every time the mode changes. The script block is provided one argument of type `ViMode`.\n" + ] }, { "name": "-ViModeIndicator", "args": [ { - "name": "Microsoft.PowerShell.ViModeStyle" + "name": "ViModeStyle", + "suggestions": [ + { + "name": "None" + }, + { + "name": "Prompt" + }, + { + "name": "Cursor" + }, + { + "name": "Script" + } + ] } - ], - "description": "This option sets the visual indicator for the current Vi mode. Either insert mode or command mode.\n" + ] }, { "name": "-WordDelimiters", "args": [ { - "name": "System.String", - "default": ";:,.[]{}()/\\|^&*-=+'\"---" + "name": "string" } - ], - "description": "Specifies the characters that delimit words for functions like ForwardWord or KillWord ." + ] }, { "name": [ @@ -392,7 +428,7 @@ } ], "args": [], - "description": "Customizes the behavior of command line editing in PSReadLine .", + "description": "Set-PSReadLineOption [-EditMode ] [-ContinuationPrompt ] [-HistoryNoDuplicates] [-AddToHistoryHandler ] [-CommandValidationHandler ] [-HistorySearchCursorMovesToEnd] [-MaximumHistoryCount ] [-MaximumKillRingCount ] [-ShowToolTips] [-ExtraPromptLineCount ] [-DingTone ] [-DingDuration ] [-BellStyle ] [-CompletionQueryItems ] [-WordDelimiters ] [-HistorySearchCaseSensitive] [-HistorySaveStyle ] [-HistorySavePath ] [-AnsiEscapeTimeout ] [-PromptText ] [-ViModeIndicator ] [-ViModeChangeHandler ] [-PredictionSource ] [-PredictionViewStyle ] [-Colors ] [-TerminateOrphanedConsoleApps] [-EnableScreenReaderMode] []", "parserDirectives": { "flagsArePosixNoncompliant": true, "flagsMatchUniquePrefix": true, diff --git a/command-signatures/json/autogenerated/powershell/set-psresourcerepository.json b/command-signatures/json/autogenerated/powershell/set-psresourcerepository.json index a34ce983..2c95c92d 100644 --- a/command-signatures/json/autogenerated/powershell/set-psresourcerepository.json +++ b/command-signatures/json/autogenerated/powershell/set-psresourcerepository.json @@ -8,24 +8,34 @@ "name": "Microsoft.PowerShell.PSResourceGet.UtilClasses.PSRepositoryInfo+APIVersion", "suggestions": [ { - "name": "unknown" + "name": "ContainerRegistry" }, { - "name": "v2" + "name": "Local" }, { - "name": "v3" + "name": "NugetServer" }, { - "name": "local" + "name": "Unknown" }, { - "name": "nugetServer" + "name": "V2" + }, + { + "name": "V3" } ] } ], - "description": "Specifies the API version used by the repository. Valid values are:\n" + "description": "Specifies the API version used by the repository. Valid values are:" + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-CredentialInfo", @@ -36,6 +46,15 @@ ], "description": "A PSCredentialInfo object that includes the name of a vault and a secret that's stored in a Microsoft.PowerShell.SecretManagement store." }, + { + "name": "-CredentialProvider", + "args": [ + { + "name": "Microsoft.PowerShell.PSResourceGet.UtilClasses.CredentialProviderType" + } + ], + "description": "This is a dynamic parameter that specifies the credential provider to use for the repository. This parameter is only available when the named repository is an Azure Artifacts feed. Valid values are:" + }, { "name": "-Name", "args": [ @@ -44,7 +63,7 @@ } ], "isRequired": true, - "description": "Specifies the name of the repository to be modified.\n" + "description": "Specifies the name of the repository to be modified." }, { "name": "-PassThru", @@ -54,11 +73,10 @@ "name": "-Priority", "args": [ { - "name": "System.Int32", - "default": "50" + "name": "System.Int32" } ], - "description": "Specifies the priority ranking of the repository. Valid priority values range from 0 to 100. Lower values have a higher priority ranking. The default value is `50`.\n" + "description": "Specifies the priority ranking of the repository. Valid priority values range from 0 to 100. Lower values have a higher priority ranking. The default value is `50`." }, { "name": "-Repository", @@ -68,7 +86,7 @@ } ], "isRequired": true, - "description": "Specifies an array of hashtables that contain repository information. Use this parameter to register multiple repositories at once. Each hashtable can only have keys associated with parameters for the NameParameterSet ." + "description": "Specifies an array of hashtables that contain repository information. Use this parameter to register multiple repositories at once. Each hashtable can only have keys associated with parameters for the NameParameterSet." }, { "name": "-Trusted", @@ -81,14 +99,7 @@ "name": "System.String" } ], - "description": "Specifies the location of the repository to be registered. The value must use one of the following URI schemas:\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the location of the repository to be registered. The value must use one of the following URI schemas:" }, { "name": [ @@ -271,7 +282,7 @@ "args": [ { "name": "-Name", - "description": "Specifies the name of the repository to be modified.\n" + "description": "Specifies the name of the repository to be modified." } ], "description": "Sets information for a registered repository.", diff --git a/command-signatures/json/autogenerated/powershell/set-pssessionconfiguration.json b/command-signatures/json/autogenerated/powershell/set-pssessionconfiguration.json new file mode 100644 index 00000000..af3b8287 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-pssessionconfiguration.json @@ -0,0 +1,421 @@ +{ + "name": "Set-PSSessionConfiguration", + "options": [ + { + "name": "-AccessMode", + "args": [ + { + "name": "System.Management.Automation.Runspaces.PSSessionConfigurationAccessMode", + "suggestions": [ + { + "name": "Disabled" + }, + { + "name": "Local" + }, + { + "name": "Remote" + } + ] + } + ], + "description": "Enables and disables the session configuration and determines whether it can be used for remote or local sessions on the computer. The acceptable values for this parameter are:" + }, + { + "name": "-ApplicationBase", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the path of the assembly file (`*.dll`) that is specified in the value of the AssemblyName parameter." + }, + { + "name": "-AssemblyName", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the assembly name. This cmdlet creates a session configuration based on a class that is defined in an assembly." + }, + { + "name": "-ConfigurationTypeName", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the type of the session configuration that is defined in the assembly in the AssemblyName parameter. The type that you specify must implement the System.Management.Automation.Remoting.PSSessionConfiguration class." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "Suppresses all user prompts, and restarts the WinRM service without prompting. Restarting the service makes the configuration change effective." + }, + { + "name": "-MaximumReceivedDataSizePerCommandMB", + "args": [ + { + "name": "System.Nullable`1[System.Double]" + } + ], + "description": "Specifies the limit on the amount of data that can be sent to this computer in any single remote command. Enter the data size in megabytes (MB). The default is `50`." + }, + { + "name": "-MaximumReceivedObjectSizeMB", + "args": [ + { + "name": "System.Nullable`1[System.Double]" + } + ], + "description": "Specifies the limits on the amount of data that can be sent to this computer in any single object. Enter the data size in megabytes. The default is `10`." + }, + { + "name": "-ModulesToImport", + "args": [ + { + "name": "System.Object[]" + } + ], + "description": "Specifies the modules and snap-ins that are automatically imported into sessions that use the session configuration. Enter the module and snap-in names." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the session configuration that you want to change." + }, + { + "name": "-NoServiceRestart", + "description": "Does not restart the WinRM service, and suppresses the prompt to restart the service." + }, + { + "name": "-Path", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the path of a session configuration file (`.pssc`), such as one created by the `New-PSSessionConfigurationFile` cmdlet. If you omit the path, the default is the current directory." + }, + { + "name": [ + "-PSVersion", + "-PowerShellVersion" + ], + "args": [ + { + "name": "System.Version" + } + ], + "description": "Specifies the version of PowerShell in sessions that use this session configuration." + }, + { + "name": "-RunAsCredential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies credentials for commands in the session. By default, commands run with the permissions of the current user." + }, + { + "name": "-SecurityDescriptorSddl", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a different Security Descriptor Definition Language (SDDL) string for the configuration." + }, + { + "name": "-SessionTypeOption", + "args": [ + { + "name": "System.Management.Automation.PSSessionTypeOption" + } + ], + "description": "Specifies type-specific options for the session configuration. Enter a session type options object, such as the PSWorkflowExecutionOption object that the `New-PSWorkflowExecutionOption` cmdlet returns." + }, + { + "name": "-ShowSecurityDescriptorUI", + "description": "When this parameter is used the cmdlet opens a property sheet that helps you create a new SDDL for the session configuration. The property sheet appears after you run the `Set-PSSessionConfiguration` command and then restart the WinRM service." + }, + { + "name": "-StartupScript", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the startup script for the configuration. Enter the fully qualified path of a PowerShell script. The specified script runs in the new session that uses the session configuration." + }, + { + "name": "-ThreadApartmentState", + "args": [ + { + "name": "System.Threading.ApartmentState", + "suggestions": [ + { + "name": "MTA" + }, + { + "name": "STA" + }, + { + "name": "Unknown" + } + ] + } + ], + "description": "Specifies the apartment state of the threading module to be used. Acceptable values are:" + }, + { + "name": "-ThreadOptions", + "args": [ + { + "name": "System.Management.Automation.Runspaces.PSThreadOptions", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "ReuseThread" + }, + { + "name": "UseCurrentThread" + }, + { + "name": "UseNewThread" + } + ] + } + ], + "description": "Specifies the thread options setting in the configuration. This setting defines how threads are created and used when a command is executed in the session. The acceptable values for this parameter are:" + }, + { + "name": "-TransportOption", + "args": [ + { + "name": "System.Management.Automation.PSTransportOption" + } + ], + "description": "Specifies the transport options for the session configuration. Enter a transport options object, such as the WSManConfigurationOption object that the `New-PSTransportOption` cmdlet returns." + }, + { + "name": "-UseSharedProcess", + "description": "Use only one process to host all sessions that are started by the same user and use the same session configuration. By default, each session is hosted in its own process." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the name of the session configuration that you want to change." + }, + { + "name": "-AssemblyName", + "description": "Specifies the assembly name. This cmdlet creates a session configuration based on a class that is defined in an assembly." + }, + { + "name": "-ConfigurationTypeName", + "description": "Specifies the type of the session configuration that is defined in the assembly in the AssemblyName parameter. The type that you specify must implement the System.Management.Automation.Remoting.PSSessionConfiguration class." + } + ], + "description": "Changes the properties of a registered session configuration.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-refsdedupschedule.json b/command-signatures/json/autogenerated/powershell/set-refsdedupschedule.json new file mode 100644 index 00000000..7d298ef1 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-refsdedupschedule.json @@ -0,0 +1,352 @@ +{ + "name": "Set-ReFSDedupSchedule", + "options": [ + { + "name": "-CompressionChunkSize", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": "-CompressionFormat", + "args": [ + { + "name": "Format", + "suggestions": [ + { + "name": "Unknown" + }, + { + "name": "Uncompressed" + }, + { + "name": "LZ4" + }, + { + "name": "ZSTD" + } + ] + } + ] + }, + { + "name": "-CompressionLevel", + "args": [ + { + "name": "uint16" + } + ] + }, + { + "name": "-CompressionTuning", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": "-ConcurrentOpenFiles", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": "-CpuPercentage", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": "-Days", + "args": [ + { + "name": "DaysOfWeek", + "suggestions": [ + { + "name": "None" + }, + { + "name": "Sunday" + }, + { + "name": "Monday" + }, + { + "name": "Tuesday" + }, + { + "name": "Wednesday" + }, + { + "name": "Thursday" + }, + { + "name": "Friday" + }, + { + "name": "Saturday" + }, + { + "name": "EveryDay" + } + ] + } + ], + "isRequired": true + }, + { + "name": "-DecompressionTuning", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": "-Duration", + "args": [ + { + "name": "timespan" + } + ] + }, + { + "name": "-ExcludeFileExtension", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-ExcludeFolder", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-MinimumLastModifiedTimeHours", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-RecompressionTuning", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": "-Start", + "args": [ + { + "name": "datetime" + } + ], + "isRequired": true + }, + { + "name": "-Volume", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Set-ReFSDedupSchedule [-Volume] -Start -Days [-Duration ] [-CpuPercentage ] [-ConcurrentOpenFiles ] [-MinimumLastModifiedTimeHours ] [-ExcludeFileExtension ] [-ExcludeFolder ] [-CompressionFormat ] [-CompressionLevel ] [-CompressionChunkSize ] [-CompressionTuning ] [-RecompressionTuning ] [-DecompressionTuning ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-refsdedupscrubschedule.json b/command-signatures/json/autogenerated/powershell/set-refsdedupscrubschedule.json new file mode 100644 index 00000000..5273d6ad --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-refsdedupscrubschedule.json @@ -0,0 +1,259 @@ +{ + "name": "Set-ReFSDedupScrubSchedule", + "options": [ + { + "name": "-Days", + "args": [ + { + "name": "DaysOfWeek", + "suggestions": [ + { + "name": "None" + }, + { + "name": "Sunday" + }, + { + "name": "Monday" + }, + { + "name": "Tuesday" + }, + { + "name": "Wednesday" + }, + { + "name": "Thursday" + }, + { + "name": "Friday" + }, + { + "name": "Saturday" + }, + { + "name": "EveryDay" + } + ] + } + ], + "isRequired": true + }, + { + "name": "-DedupDataOnly", + "args": [ + { + "name": "bool" + } + ] + }, + { + "name": "-Start", + "args": [ + { + "name": "datetime" + } + ], + "isRequired": true + }, + { + "name": "-Volume", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-WeeksInterval", + "args": [ + { + "name": "uint16" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Set-ReFSDedupScrubSchedule [-Volume] -Start -Days -WeeksInterval [-DedupDataOnly ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-scheduledjob.json b/command-signatures/json/autogenerated/powershell/set-scheduledjob.json new file mode 100644 index 00000000..4b871dcb --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-scheduledjob.json @@ -0,0 +1,182 @@ +{ + "name": "Set-ScheduledJob", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Set-ScheduledJob", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-scheduledjoboption.json b/command-signatures/json/autogenerated/powershell/set-scheduledjoboption.json new file mode 100644 index 00000000..4dc4a7a6 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-scheduledjoboption.json @@ -0,0 +1,182 @@ +{ + "name": "Set-ScheduledJobOption", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Set-ScheduledJobOption", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-securebootuefi.json b/command-signatures/json/autogenerated/powershell/set-securebootuefi.json new file mode 100644 index 00000000..199b9a28 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-securebootuefi.json @@ -0,0 +1,274 @@ +{ + "name": "Set-SecureBootUEFI", + "options": [ + { + "name": [ + "-AppendWrite", + "-append" + ], + "description": "Indicates that the contents of the current variable are appended instead of overwritten." + }, + { + "name": "-Content", + "args": [ + { + "name": "Byte[]" + } + ], + "description": "Specifies the byte contents of the variable that is being set." + }, + { + "name": [ + "-ContentFilePath", + "-f" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the file that contains the contents that is being set to the environment variable." + }, + { + "name": [ + "-Name", + "-n" + ], + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "db" + }, + { + "name": "dbx" + }, + { + "name": "KEK" + }, + { + "name": "PK" + } + ] + } + ], + "isRequired": true, + "description": "Specifies the name of the UEFI environment variable. The acceptable values for this parameter are: PK, KEK, DB, and DBX." + }, + { + "name": [ + "-OutputFilePath", + "-of" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of the file created that contains the contents of what is set. If you specify this parameter, instead of setting the variable, the cmdlet stores the contents in this file." + }, + { + "name": [ + "-SignedFilePath", + "-s" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the signed data that is paired with the contents that are being set to the environment variable." + }, + { + "name": [ + "-Time", + "-t" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the timestamp that is used in the signature. Format this value as follows so that it is accepted as a DateTime object:" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Sets the Secure Boot-related UEFI variables.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-service.json b/command-signatures/json/autogenerated/powershell/set-service.json new file mode 100644 index 00000000..15b56cc9 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-service.json @@ -0,0 +1,326 @@ +{ + "name": "Set-Service", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running `Set-Service`." + }, + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies the account used by the service as the [Service Logon Account](/windows/desktop/ad/about-service-logon-accounts)." + }, + { + "name": "-Description", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a new description for the service." + }, + { + "name": [ + "-DisplayName", + "-DN" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a new display name for the service." + }, + { + "name": "-Force", + "description": "Specifies the Stop mode of the service. This parameter only works when `-Status Stopped` is used. If enabled, `Set-Service` stops the dependent services before the target service is stopped. By default, exceptions are raised when other running services depend on the target service." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "System.ServiceProcess.ServiceController" + } + ], + "isRequired": true, + "description": "Specifies a ServiceController object that represents the service to change. Enter a variable that contains the object, or type a command or expression that gets the object, such as a `Get-Service` command. You can use the pipeline to send a service object to `Set-Service`." + }, + { + "name": [ + "-Name", + "-ServiceName", + "-SN" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the service name of the service to be changed. Wildcard characters aren't permitted. You can use the pipeline to send a service name to `Set-Service`." + }, + { + "name": "-PassThru", + "description": "Returns a ServiceController object that represents the services that were changed. By default, `Set-Service` doesn't generate any output." + }, + { + "name": [ + "-SecurityDescriptorSddl", + "-sd" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the SecurityDescriptor for the service in Sddl format. The account calling `Set-Service` with this parameter must have the WRITE_DAC and WRITE_OWNER permissions. For more information, see [Service security and access rights](/windows/win32/services/service-security-and-access-rights)." + }, + { + "name": [ + "-StartupType", + "-StartMode", + "-SM", + "-ST", + "-StartType" + ], + "args": [ + { + "name": "Microsoft.PowerShell.Commands.ServiceStartupType", + "suggestions": [ + { + "name": "Automatic" + }, + { + "name": "AutomaticDelayedStart" + }, + { + "name": "Disabled" + }, + { + "name": "InvalidValue" + }, + { + "name": "Manual" + } + ] + } + ], + "description": "Specifies the start mode of the service." + }, + { + "name": "-Status", + "args": [ + { + "name": "System.String", + "suggestions": [ + { + "name": "Paused" + }, + { + "name": "Running" + }, + { + "name": "Stopped" + } + ] + } + ], + "description": "Specifies the status for the service." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if `Set-Service` runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name" + } + ], + "description": "Starts, stops, and suspends a service, and changes its properties.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-strictmode.json b/command-signatures/json/autogenerated/powershell/set-strictmode.json index 03549a36..977f2d29 100644 --- a/command-signatures/json/autogenerated/powershell/set-strictmode.json +++ b/command-signatures/json/autogenerated/powershell/set-strictmode.json @@ -17,7 +17,7 @@ } ], "isRequired": true, - "description": "Specifies the conditions that cause an error in strict mode. This parameter accepts any valid PowerShell version number. Any number higher than `3` is treated as `Latest`. The value supplied must be the string `Latest` or a string that can be converted to a System.Version type. The version must match a valid release version of PowerShell.\n" + "description": "Specifies the conditions that cause an error in strict mode. This parameter accepts any valid PowerShell version number. Any number higher than `3` is treated as `Latest`. The value supplied must be the string `Latest` or a string that can be converted to a System.Version type. The version must match a valid release version of PowerShell." }, { "name": [ @@ -191,7 +191,7 @@ } ], "args": [], - "description": "Establishes and enforces coding rules in expressions, scripts, and script blocks.", + "description": "Establishes and enforces coding rules in expressions, scripts, and scriptblocks.", "parserDirectives": { "flagsArePosixNoncompliant": true, "flagsMatchUniquePrefix": true, diff --git a/command-signatures/json/autogenerated/powershell/set-systempreferreduilanguage.json b/command-signatures/json/autogenerated/powershell/set-systempreferreduilanguage.json new file mode 100644 index 00000000..a568372e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-systempreferreduilanguage.json @@ -0,0 +1,205 @@ +{ + "name": "Set-SystemPreferredUILanguage", + "options": [ + { + "name": [ + "-Language", + "-LanguageId", + "-LanguageTag" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "The bcp47 tag of the language to set as the System Preferred UI Language." + }, + { + "name": "-PassThru", + "description": "If specified, this parameter returns the bcp47 tag of the language upon successful configuration of the System Preferred UI Language." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Language", + "description": "The bcp47 tag of the language to set as the System Preferred UI Language." + } + ], + "description": "Sets the provided language as the System Preferred UI Language.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-timezone.json b/command-signatures/json/autogenerated/powershell/set-timezone.json new file mode 100644 index 00000000..97de97fa --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-timezone.json @@ -0,0 +1,234 @@ +{ + "name": "Set-TimeZone", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Id", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the ID of the time zone that this cmdlet sets." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "System.TimeZoneInfo" + } + ], + "isRequired": true, + "description": "Specifies a TimeZoneInfo object to use as input." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the name of the time zone that this cmdlet sets. A full list of Time Zone names can be obtained by running the following command: `Get-TimeZone -ListAvailable`." + }, + { + "name": "-PassThru", + "description": "Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name" + } + ], + "description": "Sets the system time zone to a specified time zone.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-tpmownerauth.json b/command-signatures/json/autogenerated/powershell/set-tpmownerauth.json new file mode 100644 index 00000000..949f05f2 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-tpmownerauth.json @@ -0,0 +1,235 @@ +{ + "name": "Set-TpmOwnerAuth", + "options": [ + { + "name": "-File", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a file that contains the current owner authorization value for the TPM. You can use the TPM Management Console to create this file." + }, + { + "name": [ + "-NewFile", + "-nf" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a file that contains the new owner authorization value for a TPM." + }, + { + "name": [ + "-NewOwnerAuthorization", + "-no" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a new owner authorization value for a TPM." + }, + { + "name": [ + "-OwnerAuthorization", + "-o" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the current owner authorization value for a TPM." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-OwnerAuthorization", + "description": "Specifies the current owner authorization value for a TPM." + } + ], + "description": "Changes the TPM owner authorization value.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-tracesource.json b/command-signatures/json/autogenerated/powershell/set-tracesource.json index 279e71de..d1eb895f 100644 --- a/command-signatures/json/autogenerated/powershell/set-tracesource.json +++ b/command-signatures/json/autogenerated/powershell/set-tracesource.json @@ -29,16 +29,16 @@ "name": "System.Diagnostics.TraceOptions", "suggestions": [ { - "name": "None" + "name": "Callstack" }, { - "name": "LogicalOperationStack" + "name": "DateTime" }, { - "name": "DateTime" + "name": "LogicalOperationStack" }, { - "name": "Timestamp" + "name": "None" }, { "name": "ProcessId" @@ -47,12 +47,12 @@ "name": "ThreadId" }, { - "name": "Callstack" + "name": "Timestamp" } ] } ], - "description": "Specifies optional data to the prefix of each trace message in the output. The acceptable values for this parameter are:\n" + "description": "Specifies optional data to the prefix of each trace message in the output. The acceptable values for this parameter are:" }, { "name": "-Name", @@ -71,25 +71,28 @@ "name": "System.Management.Automation.PSTraceSourceOptions", "suggestions": [ { - "name": "None" + "name": "All" + }, + { + "name": "Assert" }, { "name": "Constructor" }, { - "name": "Dispose" + "name": "Data" }, { - "name": "Finalizer" + "name": "Delegates" }, { - "name": "Method" + "name": "Dispose" }, { - "name": "Property" + "name": "Error" }, { - "name": "Delegates" + "name": "Errors" }, { "name": "Events" @@ -98,42 +101,39 @@ "name": "Exception" }, { - "name": "Lock" - }, - { - "name": "Error" + "name": "ExecutionFlow" }, { - "name": "Errors" + "name": "Finalizer" }, { - "name": "Warning" + "name": "Lock" }, { - "name": "Verbose" + "name": "Method" }, { - "name": "WriteLine" + "name": "None" }, { - "name": "Data" + "name": "Property" }, { "name": "Scope" }, { - "name": "ExecutionFlow" + "name": "Verbose" }, { - "name": "Assert" + "name": "Warning" }, { - "name": "All" + "name": "WriteLine" } ] } ], - "description": "Specifies the type of events that are traced. The acceptable values for this parameter are:\n" + "description": "Specifies the type of events that are traced. The acceptable values for this parameter are:" }, { "name": "-PassThru", @@ -159,7 +159,7 @@ "name": "System.String[]" } ], - "description": "Stops the trace by removing the trace listener.\n" + "description": "Stops the trace by removing the trace listener." }, { "name": [ @@ -339,28 +339,31 @@ }, { "name": "-Option", - "description": "Specifies the type of events that are traced. The acceptable values for this parameter are:\n", + "description": "Specifies the type of events that are traced. The acceptable values for this parameter are:", "suggestions": [ { - "name": "None" + "name": "All" + }, + { + "name": "Assert" }, { "name": "Constructor" }, { - "name": "Dispose" + "name": "Data" }, { - "name": "Finalizer" + "name": "Delegates" }, { - "name": "Method" + "name": "Dispose" }, { - "name": "Property" + "name": "Error" }, { - "name": "Delegates" + "name": "Errors" }, { "name": "Events" @@ -369,37 +372,34 @@ "name": "Exception" }, { - "name": "Lock" - }, - { - "name": "Error" + "name": "ExecutionFlow" }, { - "name": "Errors" + "name": "Finalizer" }, { - "name": "Warning" + "name": "Lock" }, { - "name": "Verbose" + "name": "Method" }, { - "name": "WriteLine" + "name": "None" }, { - "name": "Data" + "name": "Property" }, { "name": "Scope" }, { - "name": "ExecutionFlow" + "name": "Verbose" }, { - "name": "Assert" + "name": "Warning" }, { - "name": "All" + "name": "WriteLine" } ] } diff --git a/command-signatures/json/autogenerated/powershell/set-variable.json b/command-signatures/json/autogenerated/powershell/set-variable.json index d931621a..ccab08ae 100644 --- a/command-signatures/json/autogenerated/powershell/set-variable.json +++ b/command-signatures/json/autogenerated/powershell/set-variable.json @@ -1,6 +1,13 @@ { "name": "Set-Variable", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Description", "args": [ @@ -21,7 +28,7 @@ }, { "name": "-Force", - "description": "Allows you to create a variable with the same name as an existing read-only variable, or to change the value of a read-only variable.\n" + "description": "Allows you to create a variable with the same name as an existing read-only variable, or to change the value of a read-only variable." }, { "name": "-Include", @@ -50,19 +57,19 @@ "name": "System.Management.Automation.ScopedItemOptions", "suggestions": [ { - "name": "None" + "name": "AllScope" }, { - "name": "ReadOnly" + "name": "Constant" }, { - "name": "Constant" + "name": "None" }, { "name": "Private" }, { - "name": "AllScope" + "name": "ReadOnly" }, { "name": "Unspecified" @@ -70,7 +77,7 @@ ] } ], - "description": "Specifies the value of the Options property of the variable.\n" + "description": "Specifies the value of the Options property of the variable." }, { "name": "-PassThru", @@ -80,11 +87,10 @@ "name": "-Scope", "args": [ { - "name": "System.String", - "default": "Local" + "name": "System.String" } ], - "description": "Specifies the scope of the variable.The acceptable values for this parameter are:\n" + "description": "Specifies the scope of the variable.The acceptable values for this parameter are:" }, { "name": "-Value", @@ -102,23 +108,15 @@ "name": "System.Management.Automation.SessionStateEntryVisibility", "suggestions": [ { - "name": "Public" + "name": "Private" }, { - "name": "Private" + "name": "Public" } - ], - "default": "Public" + ] } ], - "description": "Determines whether the variable is visible outside of the session in which it was created. This parameter is designed for use in scripts and commands that will be delivered to other users.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Determines whether the variable is visible outside of the session in which it was created. This parameter is designed for use in scripts and commands that will be delivered to other users." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/set-wheamemorypolicy.json b/command-signatures/json/autogenerated/powershell/set-wheamemorypolicy.json new file mode 100644 index 00000000..2f1af40b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-wheamemorypolicy.json @@ -0,0 +1,248 @@ +{ + "name": "Set-WheaMemoryPolicy", + "options": [ + { + "name": [ + "-ComputerName", + "-CN" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of the remote computer from which to retrieve policy information. If you do not specify a computer name, the command returns the policy of the local computer. The alias for *ComputerName* is cn." + }, + { + "name": "-DisableOffline", + "args": [ + { + "name": "Boolean" + } + ], + "description": "Disables WHEA from taking memory pages offline in response to corrected or uncorrected memory errors." + }, + { + "name": "-DisablePFA", + "args": [ + { + "name": "Boolean" + } + ], + "description": "Disables the predictive failure analysis algorithm and stops WHEA from monitoring memory pages that have corrected errors." + }, + { + "name": "-PersistMemoryOffline", + "args": [ + { + "name": "Boolean" + } + ], + "description": "Indicates whether to persist memory-offline decisions across computer reboots." + }, + { + "name": "-PFAErrorThreshold", + "args": [ + { + "name": "UInt32" + } + ], + "description": "Specifies the number of corrected errors that must occur before a memory page in the PFA monitoring list is considered bad and is taken offline." + }, + { + "name": "-PFAPageCount", + "args": [ + { + "name": "UInt32" + } + ], + "description": "Specifies the maximum size of the PFA monitoring list for pages that experience corrected memory errors." + }, + { + "name": "-PFATimeout", + "args": [ + { + "name": "UInt32" + } + ], + "description": "Specifies the number of seconds that WHEA monitors a memory page using PFA. WHEA starts monitoring a memory page when the page has its first corrected error. WHEA stops monitoring a memory page when one of the following events occurs:" + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Sets the WHEA memory policy for a computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-winacceptlanguagefromlanguagelistoptout.json b/command-signatures/json/autogenerated/powershell/set-winacceptlanguagefromlanguagelistoptout.json new file mode 100644 index 00000000..fa8fba1a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-winacceptlanguagefromlanguagelistoptout.json @@ -0,0 +1,197 @@ +{ + "name": "Set-WinAcceptLanguageFromLanguageListOptOut", + "options": [ + { + "name": "-OptOut", + "args": [ + { + "name": "Boolean" + } + ], + "isRequired": true, + "description": "Specifies the opt-out value." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-OptOut", + "description": "Specifies the opt-out value." + } + ], + "description": "Sets the HTTP Accept Language from the Language List opt-out setting for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-winculturefromlanguagelistoptout.json b/command-signatures/json/autogenerated/powershell/set-winculturefromlanguagelistoptout.json new file mode 100644 index 00000000..61f4c925 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-winculturefromlanguagelistoptout.json @@ -0,0 +1,197 @@ +{ + "name": "Set-WinCultureFromLanguageListOptOut", + "options": [ + { + "name": "-OptOut", + "args": [ + { + "name": "Boolean" + } + ], + "isRequired": true, + "description": "Specifies the opt-out value." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-OptOut", + "description": "Specifies the opt-out value." + } + ], + "description": "Sets the Culture from language list opt out setting for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-windefaultinputmethodoverride.json b/command-signatures/json/autogenerated/powershell/set-windefaultinputmethodoverride.json new file mode 100644 index 00000000..45ed44b3 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-windefaultinputmethodoverride.json @@ -0,0 +1,196 @@ +{ + "name": "Set-WinDefaultInputMethodOverride", + "options": [ + { + "name": "-InputTip", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies an input tip." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputTip", + "description": "Specifies an input tip." + } + ], + "description": "Sets the default input method override for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-windowsedition.json b/command-signatures/json/autogenerated/powershell/set-windowsedition.json new file mode 100644 index 00000000..51a2f0d3 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-windowsedition.json @@ -0,0 +1,267 @@ +{ + "name": "Set-WindowsEdition", + "options": [ + { + "name": "-Edition", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the target edition to change the Windows image to." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Changes a Windows image to a higher edition.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-windowsproductkey.json b/command-signatures/json/autogenerated/powershell/set-windowsproductkey.json new file mode 100644 index 00000000..c26c7f18 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-windowsproductkey.json @@ -0,0 +1,267 @@ +{ + "name": "Set-WindowsProductKey", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ProductKey", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the product key to use for the Windows image." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Sets the product key for the Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-windowsreservedstoragestate.json b/command-signatures/json/autogenerated/powershell/set-windowsreservedstoragestate.json new file mode 100644 index 00000000..00f42f0f --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-windowsreservedstoragestate.json @@ -0,0 +1,247 @@ +{ + "name": "Set-WindowsReservedStorageState", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-State", + "args": [ + { + "name": "ReservedStorageState", + "suggestions": [ + { + "name": "Disabled" + }, + { + "name": "Enabled" + } + ] + } + ], + "isRequired": true, + "description": "The reserved storage state of the image, either Disabled or Enabled." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Sets the reserved storage state of the image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-windowssearchsetting.json b/command-signatures/json/autogenerated/powershell/set-windowssearchsetting.json new file mode 100644 index 00000000..0875d44d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-windowssearchsetting.json @@ -0,0 +1,240 @@ +{ + "name": "Set-WindowsSearchSetting", + "options": [ + { + "name": "-EnableMeteredWebResultsSetting", + "args": [ + { + "name": "Boolean" + } + ], + "description": "Indicates whether Windows Search displays web results and suggestions while using metered connections. Specify a value of $True to display web results and suggestions over metered connections or a value of $False to exclude web results and suggestions." + }, + { + "name": "-EnableWebResultsSetting", + "args": [ + { + "name": "Boolean" + } + ], + "description": "Indicates whether Windows Search displays web results and suggestions. Specify a value of $True to display web results and suggestions or a value of $False to exclude web results and suggestions." + }, + { + "name": "-SafeSearchSetting", + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "Moderate" + }, + { + "name": "Off" + }, + { + "name": "Strict" + } + ] + } + ], + "description": "Specifies a SafeSearch setting for Window Search." + }, + { + "name": "-SearchExperienceSetting", + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "NotPersonalized" + }, + { + "name": "Personalized" + }, + { + "name": "PersonalizedAndLocation" + } + ] + } + ], + "description": "Specifies a Windows Search experience setting." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Modifies values that control Windows Search.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-winhomelocation.json b/command-signatures/json/autogenerated/powershell/set-winhomelocation.json new file mode 100644 index 00000000..ab79cee0 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-winhomelocation.json @@ -0,0 +1,197 @@ +{ + "name": "Set-WinHomeLocation", + "options": [ + { + "name": "-GeoId", + "args": [ + { + "name": "Int32" + } + ], + "isRequired": true, + "description": "Specifies a GeoID setting." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-GeoId", + "description": "Specifies a GeoID setting." + } + ], + "description": "Sets the home location setting for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-winlanguagebaroption.json b/command-signatures/json/autogenerated/powershell/set-winlanguagebaroption.json new file mode 100644 index 00000000..8940f827 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-winlanguagebaroption.json @@ -0,0 +1,190 @@ +{ + "name": "Set-WinLanguageBarOption", + "options": [ + { + "name": "-UseLegacyLanguageBar", + "description": "Indicates that this cmdlet sets the language bar mode to the legacy setting. If you do not specify this parameter, the cmdlet sets the language bar mode to the default setting." + }, + { + "name": "-UseLegacySwitchMode", + "description": "Indicates that this cmdlet sets the language bar switch mode to the legacy or per-thread setting. If you do not specify this parameter, the cmdlet sets the language bar switch mode to the default or per-user setting." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Sets the language bar type and mode for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-winsystemlocale.json b/command-signatures/json/autogenerated/powershell/set-winsystemlocale.json new file mode 100644 index 00000000..90ce2633 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-winsystemlocale.json @@ -0,0 +1,197 @@ +{ + "name": "Set-WinSystemLocale", + "options": [ + { + "name": "-SystemLocale", + "args": [ + { + "name": "CultureInfo" + } + ], + "isRequired": true, + "description": "Specifies a system locale." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-SystemLocale", + "description": "Specifies a system locale." + } + ], + "description": "Sets the system locale for the current computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-winuilanguageoverride.json b/command-signatures/json/autogenerated/powershell/set-winuilanguageoverride.json new file mode 100644 index 00000000..51376745 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-winuilanguageoverride.json @@ -0,0 +1,196 @@ +{ + "name": "Set-WinUILanguageOverride", + "options": [ + { + "name": "-Language", + "args": [ + { + "name": "CultureInfo" + } + ], + "description": "Specifies a language." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Language", + "description": "Specifies a language." + } + ], + "description": "Sets the Windows UI language override setting for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-winuserlanguagelist.json b/command-signatures/json/autogenerated/powershell/set-winuserlanguagelist.json new file mode 100644 index 00000000..f23cba37 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-winuserlanguagelist.json @@ -0,0 +1,215 @@ +{ + "name": "Set-WinUserLanguageList", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "" + }, + { + "name": "-LanguageList", + "args": [ + { + "name": "System.Collections.Generic.List`1[Microsoft.InternationalSettings.Commands.WinUserLanguage]" + } + ], + "isRequired": true, + "description": "Specifies a language list." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-LanguageList", + "description": "Specifies a language list." + } + ], + "description": "Sets the language list and associated properties for the current user account.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-wmiinstance.json b/command-signatures/json/autogenerated/powershell/set-wmiinstance.json new file mode 100644 index 00000000..200f1979 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-wmiinstance.json @@ -0,0 +1,381 @@ +{ + "name": "Set-WmiInstance", + "options": [ + { + "name": [ + "-Arguments", + "-Args", + "-Property" + ], + "args": [ + { + "name": "hashtable" + } + ] + }, + { + "name": "-AsJob" + }, + { + "name": "-Authentication", + "args": [ + { + "name": "AuthenticationLevel", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "None" + }, + { + "name": "Connect" + }, + { + "name": "Call" + }, + { + "name": "Packet" + }, + { + "name": "PacketIntegrity" + }, + { + "name": "PacketPrivacy" + }, + { + "name": "Unchanged" + } + ] + } + ] + }, + { + "name": "-Authority", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Class", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-ComputerName", + "-Cn" + ], + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Credential", + "args": [ + { + "name": "pscredential" + } + ] + }, + { + "name": "-EnableAllPrivileges" + }, + { + "name": "-Impersonation", + "args": [ + { + "name": "ImpersonationLevel", + "suggestions": [ + { + "name": "Default" + }, + { + "name": "Anonymous" + }, + { + "name": "Identify" + }, + { + "name": "Impersonate" + }, + { + "name": "Delegate" + } + ] + } + ] + }, + { + "name": "-InputObject", + "args": [ + { + "name": "wmi" + } + ], + "isRequired": true + }, + { + "name": "-Locale", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Namespace", + "-NS" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Path", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": "-PutType", + "args": [ + { + "name": "PutType", + "suggestions": [ + { + "name": "None" + }, + { + "name": "UpdateOnly" + }, + { + "name": "CreateOnly" + }, + { + "name": "UpdateOrCreate" + } + ] + } + ] + }, + { + "name": "-ThrottleLimit", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Class" + }, + { + "name": "-Arguments" + } + ], + "description": "Set-WmiInstance [-Class] [[-Arguments] ] [-PutType ] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] [] Set-WmiInstance -InputObject [-Arguments ] [-PutType ] [-AsJob] [-ThrottleLimit ] [-WhatIf] [-Confirm] [] Set-WmiInstance -Path [-Arguments ] [-PutType ] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] [] Set-WmiInstance [-PutType ] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] [] Set-WmiInstance [-PutType ] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] [] Set-WmiInstance [-PutType ] [-AsJob] [-Impersonation ] [-Authentication ] [-Locale ] [-EnableAllPrivileges] [-Authority ] [-Credential ] [-ThrottleLimit ] [-ComputerName ] [-Namespace ] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-wsmaninstance.json b/command-signatures/json/autogenerated/powershell/set-wsmaninstance.json new file mode 100644 index 00000000..100bc1f5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-wsmaninstance.json @@ -0,0 +1,383 @@ +{ + "name": "Set-WSManInstance", + "options": [ + { + "name": "-ApplicationName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the application name in the connection. The default value of the ApplicationName parameter is \"WSMAN\". The complete identifier for the remote endpoint is in the following format:" + }, + { + "name": [ + "-Authentication", + "-auth", + "-am" + ], + "args": [ + { + "name": "Microsoft.WSMan.Management.AuthenticationMechanism", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "ClientCertificate" + }, + { + "name": "Credssp" + }, + { + "name": "Default" + }, + { + "name": "Digest" + }, + { + "name": "Kerberos" + }, + { + "name": "Negotiate" + }, + { + "name": "None" + } + ] + } + ], + "description": "Specifies the authentication mechanism to be used at the server. Possible values are:" + }, + { + "name": "-CertificateThumbprint", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to perform this action. Enter the certificate thumbprint of the certificate." + }, + { + "name": [ + "-ComputerName", + "-cn" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the computer against which you want to run the management operation. The value can be a fully qualified domain name, a NetBIOS name, or an IP address. Use the local computer name, `localhost`, or a dot (`.`) to specify the local computer. The local computer is the default." + }, + { + "name": "-ConnectionURI", + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the connection endpoint. The format of this string is:" + }, + { + "name": [ + "-Credential", + "-cred", + "-c" + ], + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to perform this action. The default is the current user. Type a user name, such as `User01`, `Domain01\\User01`, or `User@Domain.com`. Alternatively, enter a PSCredential object, such as one returned by the `Get-Credential` cmdlet. When you type a user name, you will be prompted for a password." + }, + { + "name": "-Dialect", + "args": [ + { + "name": "System.Uri" + } + ], + "description": "Specifies the dialect to use in the filter predicate. This can be any dialect that is supported by the remote service. The following aliases can be used for the dialect URI:" + }, + { + "name": [ + "-FilePath", + "-Path" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the path of a file that is used to update a management resource. You specify the management resource by using the ResourceURI parameter and the SelectorSet parameter. For example, the following command uses the FilePath parameter:" + }, + { + "name": "-Fragment", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies a section inside the instance that is to be updated or retrieved for the specified operation. For example, to get the status of a spooler service, specify `-Fragment Status`." + }, + { + "name": [ + "-OptionSet", + "-os" + ], + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "description": "Passes a set of switches to a service to modify or refine the nature of the request. These are similar to switches used in command-line shells because they are service specific. Any number of options can be specified." + }, + { + "name": "-Port", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies the port to use when the client connects to the WinRM service. When the transport is HTTP, the default port is 80. When the transport is HTTPS, the default port is 443." + }, + { + "name": [ + "-ResourceURI", + "-ruri" + ], + "args": [ + { + "name": "System.Uri" + } + ], + "isRequired": true, + "description": "Contains the Uniform Resource Identifier (URI) of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": "-SelectorSet", + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "description": "Specifies a set of value pairs that are used to select particular management resource instances. The SelectorSet parameter is used when more than one instance of the resource exists. The value of the SelectorSet parameter must be a hash table. The following example shows how to enter a value for this parameter:" + }, + { + "name": [ + "-SessionOption", + "-so" + ], + "args": [ + { + "name": "Microsoft.WSMan.Management.SessionOption" + } + ], + "description": "Defines a set of extended options for the WS-Management session. Enter a SessionOption object that you create with the `New-WSManSessionOption` cmdlet. For more information about the options that are available, see [New-WSManSessionOption](New-WSManSessionOption.md)." + }, + { + "name": [ + "-UseSSL", + "-ssl" + ], + "description": "Specifies that the Secure Sockets Layer (SSL) protocol should be used to establish a connection to the remote computer. By default, SSL is not used." + }, + { + "name": "-ValueSet", + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "description": "Specifies a hash table that helps modify a management resource. You specify the management resource by using the ResourceURI parameter and the SelectorSet parameter. The value of the ValueSet parameter must be a hash table." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ResourceURI", + "description": "Contains the Uniform Resource Identifier (URI) of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer." + }, + { + "name": "-SelectorSet", + "description": "Specifies a set of value pairs that are used to select particular management resource instances. The SelectorSet parameter is used when more than one instance of the resource exists. The value of the SelectorSet parameter must be a hash table. The following example shows how to enter a value for this parameter:" + } + ], + "description": "Modifies the management information that is related to a resource.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/set-wsmanquickconfig.json b/command-signatures/json/autogenerated/powershell/set-wsmanquickconfig.json new file mode 100644 index 00000000..2cc0470b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/set-wsmanquickconfig.json @@ -0,0 +1,194 @@ +{ + "name": "Set-WSManQuickConfig", + "options": [ + { + "name": "-Force", + "description": "Forces the command to run without asking for user confirmation." + }, + { + "name": "-SkipNetworkProfileCheck", + "description": "Configures Windows client versions for remoting when the computer is on a public network. This parameter enables a firewall rule for public networks that allows remote access only from computers in the same local subnet." + }, + { + "name": "-UseSSL", + "description": "Specifies that the Secure Sockets Layer (SSL) protocol is used to establish a connection to the remote computer. By default, SSL isn't used." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Configures the local computer for remote management.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/show-command.json b/command-signatures/json/autogenerated/powershell/show-command.json new file mode 100644 index 00000000..3312ec03 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/show-command.json @@ -0,0 +1,229 @@ +{ + "name": "Show-Command", + "options": [ + { + "name": "-ErrorPopup", + "description": "Indicates that the cmdlet displays errors in a pop-up window, in addition to displaying them at the command line. By default, when a command that is run in a `Show-Command` window generates an error, the error is displayed only at the command line." + }, + { + "name": "-Height", + "args": [ + { + "name": "System.Double" + } + ], + "description": "Specifies the height of the `Show-Command` window in pixels. Enter a value between 300 and the number of pixels in the screen resolution. If the value is too large to display the command window on the screen, `Show-Command` generates an error. The default height is 600 pixels. For a `Show-Command` command that includes the Name parameter, the default height is 300 pixels." + }, + { + "name": [ + "-Name", + "-CommandName" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Displays a command window for the specified command. Enter the name of one command, such as the name of a cmdlet, function, or CIM command. If you omit this parameter, `Show-Command` displays a command window that lists all of the PowerShell commands in all modules installed on the computer." + }, + { + "name": "-NoCommonParameter", + "description": "Indicates that this cmdlet omits the Common Parameters section of the command display. By default, the Common Parameters appear in an expandable section at the bottom of the command window." + }, + { + "name": "-PassThru", + "description": "Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. To run the command string, copy and paste it at the command prompt or save it in a variable and use the `Invoke-Expression` cmdlet to run the string in the variable." + }, + { + "name": "-Width", + "args": [ + { + "name": "System.Double" + } + ], + "description": "Specifies the width of the `Show-Command` window in pixels. Enter a value between 300 and the number of pixels in the screen resolution. If the value is too large to display the command window on the screen, `Show-Command` generates an error. The default width is 300 pixels." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Displays a command window for the specified command. Enter the name of one command, such as the name of a cmdlet, function, or CIM command. If you omit this parameter, `Show-Command` displays a command window that lists all of the PowerShell commands in all modules installed on the computer." + } + ], + "description": "Displays PowerShell command information in a graphical window.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/show-controlpanelitem.json b/command-signatures/json/autogenerated/powershell/show-controlpanelitem.json new file mode 100644 index 00000000..c1c6039d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/show-controlpanelitem.json @@ -0,0 +1,212 @@ +{ + "name": "Show-ControlPanelItem", + "options": [ + { + "name": "-CanonicalName", + "args": [ + { + "name": "string[]" + } + ], + "isRequired": true + }, + { + "name": "-InputObject", + "args": [ + { + "name": "ControlPanelItem[]" + } + ] + }, + { + "name": "-Name", + "args": [ + { + "name": "string[]" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name" + } + ], + "description": "Show-ControlPanelItem [-Name] [] Show-ControlPanelItem -CanonicalName [] Show-ControlPanelItem [[-InputObject] ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/show-eventlog.json b/command-signatures/json/autogenerated/powershell/show-eventlog.json new file mode 100644 index 00000000..712e39eb --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/show-eventlog.json @@ -0,0 +1,197 @@ +{ + "name": "Show-EventLog", + "options": [ + { + "name": [ + "-ComputerName", + "-CN" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ComputerName" + } + ], + "description": "Show-EventLog [[-ComputerName] ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/show-windowsdeveloperlicenseregistration.json b/command-signatures/json/autogenerated/powershell/show-windowsdeveloperlicenseregistration.json new file mode 100644 index 00000000..6783cf03 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/show-windowsdeveloperlicenseregistration.json @@ -0,0 +1,182 @@ +{ + "name": "Show-WindowsDeveloperLicenseRegistration", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Provides information about how to enable a device for development.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/sort-object.json b/command-signatures/json/autogenerated/powershell/sort-object.json index 7cb559cb..7052e499 100644 --- a/command-signatures/json/autogenerated/powershell/sort-object.json +++ b/command-signatures/json/autogenerated/powershell/sort-object.json @@ -9,7 +9,7 @@ } ], "isRequired": true, - "description": "Specifies the number of objects to get from the end of a sorted object array. This results in a stable sort.\n" + "description": "Specifies the number of objects to get from the end of a sorted object array. This results in a stable sort." }, { "name": "-CaseSensitive", @@ -26,7 +26,7 @@ }, { "name": "-Descending", - "description": "Indicates that `Sort-Object` sorts the objects in descending order. The default is ascending order.\n" + "description": "Indicates that `Sort-Object` sorts the objects in descending order. The default is ascending order." }, { "name": "-InputObject", @@ -41,15 +41,14 @@ "name": "-Property", "args": [ { - "name": "System.Object[]", - "default": "Default properties" + "name": "System.Object[]" } ], - "description": "Specifies the property names that `Sort-Object` uses to sort the objects. Wildcards are permitted. Objects are sorted based on the property values. If you don't specify a property, `Sort-Object` sorts based on default properties for the object type or the objects themselves.\n" + "description": "Specifies the property names that `Sort-Object` uses to sort the objects. Wildcards are permitted. Objects are sorted based on the property values. If you don't specify a property, `Sort-Object` sorts based on default properties for the object type or the objects themselves." }, { "name": "-Stable", - "description": "The sorted objects are delivered in the order they were received when the sort criteria are equal.\n" + "description": "The sorted objects are delivered in the order they were received when the sort criteria are equal." }, { "name": "-Top", @@ -59,11 +58,11 @@ } ], "isRequired": true, - "description": "Specifies the number of objects to get from the start of a sorted object array. This results in a stable sort.\n" + "description": "Specifies the number of objects to get from the start of a sorted object array. This results in a stable sort." }, { "name": "-Unique", - "description": "Indicates that `Sort-Object` eliminates duplicates and returns only the unique members of the collection. The first instance of a unique value is included in the sorted output. Unique is case-insensitive. Strings that only differ by character case are considered the same. For example, character and CHARACTER." + "description": "Indicates that `Sort-Object` eliminates duplicates and returns only the unique members of the collection. The first instance of a unique value is included in the sorted output." }, { "name": [ @@ -239,7 +238,7 @@ "args": [ { "name": "-Property", - "description": "Specifies the property names that `Sort-Object` uses to sort the objects. Wildcards are permitted. Objects are sorted based on the property values. If you don't specify a property, `Sort-Object` sorts based on default properties for the object type or the objects themselves.\n" + "description": "Specifies the property names that `Sort-Object` uses to sort the objects. Wildcards are permitted. Objects are sorted based on the property values. If you don't specify a property, `Sort-Object` sorts based on default properties for the object type or the objects themselves." } ], "description": "Sorts objects by property values.", diff --git a/command-signatures/json/autogenerated/powershell/split-path.json b/command-signatures/json/autogenerated/powershell/split-path.json index 72bf28a9..56c54b3a 100644 --- a/command-signatures/json/autogenerated/powershell/split-path.json +++ b/command-signatures/json/autogenerated/powershell/split-path.json @@ -7,27 +7,28 @@ { "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter isn't supported by any providers installed with PowerShell. To impersonate another > user, or elevate your credentials when running this cmdlet, use > [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Extension", "isRequired": true, - "description": "Indicates that this cmdlet returns only the extension of the leaf. For example, in the path `C:\\Test\\Logs\\Pass1.log`, it returns only `.log`.\n" + "description": "Indicates that this cmdlet returns only the extension of the leaf. For example, in the path `C:\\Test\\Logs\\Pass1.log`, it returns only `.log`." }, { "name": "-IsAbsolute", "isRequired": true, - "description": "Indicates that this cmdlet returns `$True` if the path is absolute and `$False` if it's relative. An absolute path has a length greater than zero and doesn't use a dot (`.`) to indicate the current path." + "description": "Indicates that this cmdlet returns `$true` if the path is absolute and `$false` if it's relative. On Windows, an absolute path string must start with a provider drive specifier, like `C:` or `HKCU:`. A relative path starts with a dot (`.`) or a dot-dot (`..`)." }, { "name": "-Leaf", "isRequired": true, - "description": "Indicates that this cmdlet returns only the last item or container in the path. For example, in the path `C:\\Test\\Logs\\Pass1.log`, it returns only `Pass1.log`." + "description": "When using the Leaf parameter, `Split-Path` returns only the last item in the path string supplied, regardless whether that item is a file or a directory." }, { "name": "-LeafBase", "isRequired": true, - "description": "Indicates that this cmdlet returns only base name of the leaf. For example, in the path `C:\\Test\\Logs\\Pass1.log`, it returns only `Pass1`.\n" + "description": "Indicates that this cmdlet returns only base name of the leaf. For example, in the path `C:\\Test\\Logs\\Pass1.log`, it returns only `Pass1`." }, { "name": [ @@ -41,7 +42,7 @@ } ], "isRequired": true, - "description": "Specifies the paths to be split. Unlike Path , the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + "description": "Specifies the paths to be split. Unlike Path, the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-NoQualifier", @@ -50,7 +51,7 @@ }, { "name": "-Parent", - "description": "Indicates that this cmdlet returns only the parent containers of the item or of the container specified by the path. For example, in the path `C:\\Test\\Logs\\Pass1.log`, it returns `C:\\Test\\Logs`. The Parent parameter is the default split location parameter." + "description": "`Split-Path` returns only the parent container portion of the path string supplied. If the Path string doesn't contain a parent container, `Split-Path` returns an empty string." }, { "name": "-Path", @@ -65,7 +66,7 @@ { "name": "-Qualifier", "isRequired": true, - "description": "Indicates that this cmdlet returns only the qualifier of the specified path. For the FileSystem or registry providers, the qualifier is the drive of the provider path, such as `C:` or `HKCU:`." + "description": "Indicates that this cmdlet returns only the qualifier of the specified path. For the FileSystem or Registry providers, the qualifier is the drive of the provider path, such as `C:` or `HKCU:`." }, { "name": "-Resolve", diff --git a/command-signatures/json/autogenerated/powershell/split-windowsimage.json b/command-signatures/json/autogenerated/powershell/split-windowsimage.json new file mode 100644 index 00000000..54bce0f7 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/split-windowsimage.json @@ -0,0 +1,263 @@ +{ + "name": "Split-WindowsImage", + "options": [ + { + "name": "-CheckIntegrity", + "description": "Detects and tracks .wim file corruption when used with the Add-WindowsImage, Dismount-WindowsImage, or Save-WindowsImage cmdlet. CheckIntegrity stops the operation if DISM detects that the .wim file is corrupted when used with the Expand-WindowsImage or Mount-WindowsImage cmdlet." + }, + { + "name": "-FileSize", + "args": [ + { + "name": "UInt64" + } + ], + "isRequired": true, + "description": "Specifies the maximum size in megabytes (MB) for each created .swm file." + }, + { + "name": "-ImagePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location of a WIM file." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SplitImagePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location and the base split image file name." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Splits an existing .wim file into multiple read-only split .wim files.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/start-bitstransfer.json b/command-signatures/json/autogenerated/powershell/start-bitstransfer.json new file mode 100644 index 00000000..6c97726a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/start-bitstransfer.json @@ -0,0 +1,668 @@ +{ + "name": "Start-BitsTransfer", + "options": [ + { + "name": "-ACLFlags", + "args": [ + { + "name": "ACLFlagValue", + "suggestions": [ + { + "name": "DACL" + }, + { + "name": "Group" + }, + { + "name": "None" + }, + { + "name": "Owner" + }, + { + "name": "SACL" + } + ] + } + ], + "description": "Specifies the owner and access control list (ACL) information to maintain for the transfer job. Specify one or more of the following values:" + }, + { + "name": "-Asynchronous", + "description": "Indicates that the cmdlet creates and processes BITS transfer job in the background. The command prompt reappears immediately after the BITS transfer job is created. The returned BitsJob object can be used to monitor status and progress." + }, + { + "name": "-Authentication", + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "Digest" + }, + { + "name": "Negotiate" + }, + { + "name": "Ntlm" + }, + { + "name": "Passport" + } + ] + } + ], + "description": "Specifies the authentication mechanism to be used at the server. The acceptable values for this parameter are:" + }, + { + "name": "-CertHash", + "args": [ + { + "name": "Byte[]" + } + ], + "description": "Specifies a SHA1 hash that identifies the certificate." + }, + { + "name": "-CertStoreLocation", + "args": [ + { + "name": "CertStoreLocationValue", + "suggestions": [ + { + "name": "CurrentService" + }, + { + "name": "CurrentUser" + }, + { + "name": "CurrentUserGroupPolicy" + }, + { + "name": "LocalMachine" + }, + { + "name": "LocalMachineEnterprise" + }, + { + "name": "LocalMachineGroupPolicy" + }, + { + "name": "Services" + }, + { + "name": "Users" + } + ] + } + ], + "description": "Specifies the certificate store location to use for to look up the certificate. Valid values are:" + }, + { + "name": "-CertStoreName", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the name of the certificate store. Valid values are:" + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Credential", + "args": [ + { + "name": "PSCredential" + } + ], + "description": "Specifies the credentials to use to authenticate the user to the server that is specified in the value of the *Source* parameter. The default is the current user." + }, + { + "name": "-CustomHeaders", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies one or more custom HTTP headers to include in the request to the server. Specify an array of strings." + }, + { + "name": "-CustomHeadersWriteOnly", + "description": "Indicates that the HTTP custom headers for this job are write-only." + }, + { + "name": "-Description", + "args": [ + { + "name": "String" + } + ], + "description": "Describes the BITS transfer job. The description is limited to 1,024 characters." + }, + { + "name": "-Destination", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies an array that contains the destination location and the names of the files that you want to transfer. The destination names are paired with the corresponding source file names. For example, the first file name specified in the *Source* parameter corresponds to the first file name in the *Destination* parameter, and the second file name in the *Source* parameter corresponds to the second file name in the *Destination* parameter. The *Source* and *Destination* parameters must have the same number of elements; otherwise, the command produces an error." + }, + { + "name": "-DisplayName", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a display name for the BITS transfer job. The display name provides a user-friendly way to differentiate BITS transfer jobs." + }, + { + "name": "-Dynamic", + "description": "Indicates that the transfer uses the dynamic setting." + }, + { + "name": "-HttpMethod", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a method for the transfer other than the default method GET. If you specify GET, the parameter has no effect." + }, + { + "name": "-MaxDownloadTime", + "args": [ + { + "name": "Int32" + } + ], + "description": "Specifies the maximum time, in seconds, for transferring the files in a job. The default is 7,776,000 seconds or 90 days." + }, + { + "name": "-NotifyCmdLine", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies a program to run after the job finishes or encounters an error. The program runs in the context of the user who runs this cmdlet." + }, + { + "name": "-NotifyFlags", + "args": [ + { + "name": "NotifyFlagValue" + } + ], + "description": "Specifies the type of event notification you want to receive, such as job transferred events. Valid values are:" + }, + { + "name": "-Priority", + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "Foreground" + }, + { + "name": "High" + }, + { + "name": "Low" + }, + { + "name": "Normal" + } + ] + } + ], + "description": "Sets the priority of the BITS transfer job, which affects bandwidth usage. The acceptable values for this parameter are:" + }, + { + "name": "-ProxyAuthentication", + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "Digest" + }, + { + "name": "Negotiate" + }, + { + "name": "Ntlm" + }, + { + "name": "Passport" + } + ] + } + ], + "description": "Specifies the authentication mechanism to use at the Web proxy. The acceptable values for this parameter are:" + }, + { + "name": "-ProxyBypass", + "args": [ + { + "name": "String[]" + } + ], + "description": "Specifies a list of host names to use for a direct connection. The hosts in the list are tried in order until a successful connection is achieved. If you specify this parameter the cmdlet bypasses the proxy. If this parameter is used, the *ProxyUsage* parameter must be set to Override; otherwise, an error occurs." + }, + { + "name": "-ProxyCredential", + "args": [ + { + "name": "PSCredential" + } + ], + "description": "Specifies the credentials to use to authenticate the user at the proxy. You can use the Get-Credential cmdlet to create a value for this parameter." + }, + { + "name": "-ProxyList", + "args": [ + { + "name": "Uri[]" + } + ], + "description": "Specifies a list of proxies to use. The proxies in the list are tried in order until a successful connection is achieved. If this parameter is specified and *ProxyUsage* is set to a value other than Override, the cmdlet generates an error." + }, + { + "name": "-ProxyUsage", + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "AutoDetect" + }, + { + "name": "NoProxy" + }, + { + "name": "Override" + }, + { + "name": "SystemDefault" + } + ] + } + ], + "description": "Specifies the proxy usage settings. The acceptable values for this parameter are:" + }, + { + "name": "-RetryInterval", + "args": [ + { + "name": "Int32" + } + ], + "description": "Specifies the minimum length of time, in seconds, that BITS waits before an attempt to transfer the file after BITS encounters a transient error. The minimum allowed value is 60 seconds. If this value exceeds the RetryTimeout value from the BitsJob object, BITS does not retry the transfer. Instead, BITS sets the state of the BITS transfer job to the Error state." + }, + { + "name": "-RetryTimeout", + "args": [ + { + "name": "Int32" + } + ], + "description": "Specifies the length of time, in seconds, that BITS attempts to transfer the file after the first transient error occurs. Setting the retry period to 0 prevents retries and forces the job into the `BG_JOB_STATE_ERROR` state when an error occurs. If the retry period value exceeds the JobInactivityTimeout Group Policy setting (90-day default), BITS cancels the job after the JobInactivityTimeout Group Policy setting is exceeded." + }, + { + "name": "-SecurityFlags", + "args": [ + { + "name": "SecurityFlagValue", + "suggestions": [ + { + "name": "EnableCRLCheck" + }, + { + "name": "IgnoreCertCNInvalid" + }, + { + "name": "IgnoreCertDateInvalid" + }, + { + "name": "IgnoreCertWrongUsage" + }, + { + "name": "IgnoreUnknownCA" + }, + { + "name": "RedirectPolicyAllowHttpsToHttp" + }, + { + "name": "RedirectPolicyAllowReport" + }, + { + "name": "RedirectPolicyAllowSilent" + }, + { + "name": "RedirectPolicyDisallow" + } + ] + } + ], + "description": "Specifies security flags for the HTTP request." + }, + { + "name": "-Source", + "args": [ + { + "name": "String[]" + } + ], + "isRequired": true, + "description": "Specifies the source location and the names of the files that you want to transfer. The source file names are paired with the corresponding destination file names. For example, the first file name specified in the *Source* parameter corresponds to the first file name in the *Destination* parameter, and the second file name in the *Source* parameter corresponds to the second file name in the *Destination* parameter. The *Source* and *Destination* parameters must have the same number of elements; otherwise, the command produces an error. You can use standard wildcard characters such as the asterisk (*) and the question mark (?). Or, you can use a range operator such as \"\\[a-r\\]\"." + }, + { + "name": "-Suspended", + "description": "Indicates that the cmdlet suspends the BITS transfer job. If the *Suspended* parameter is not specified, the job automatically begins the transfer job. If the *Suspended* parameter is specified, the command prompt returns immediately after the BITS transfer job is created. You can use the Resume-BitsTransfer cmdlet to start the transfer job." + }, + { + "name": "-TransferPolicy", + "args": [ + { + "name": "CostStates", + "suggestions": [ + { + "name": "Always" + }, + { + "name": "BelowCap" + }, + { + "name": "Capped" + }, + { + "name": "IgnoreCongestion" + }, + { + "name": "NearCap" + }, + { + "name": "None" + }, + { + "name": "NoSurcharge" + }, + { + "name": "NotRoaming" + }, + { + "name": "OverCapCharged" + }, + { + "name": "OverCapThrottled" + }, + { + "name": "PolicyUnrestricted" + }, + { + "name": "Roaming" + }, + { + "name": "Standard" + }, + { + "name": "Unrestricted" + }, + { + "name": "UsageBased" + } + ] + } + ], + "description": "Specifies the network cost states in which the transfer is allowed to be scheduled. The current cost state of the network is a bitmask that indicates the kinds of charges that would be incurred if a transfer was scheduled at this time. This cost state represents a bitmask; if the bit corresponding to the current network cost state is set, the transfer can be scheduled. If the bit corresponding to the current network cost state is not set, the transfer is ignored for scheduling purposes. You can submit any of the named values listed here, or add them together to provide a custom value." + }, + { + "name": "-TransferType", + "args": [ + { + "name": "String", + "suggestions": [ + { + "name": "Download" + }, + { + "name": "Upload" + }, + { + "name": "UploadReply" + } + ] + } + ], + "description": "Specifies the BITS transfer job type. The acceptable values for this parameter are:" + }, + { + "name": "-UseStoredCredential", + "args": [ + { + "name": "AuthenticationTargetValue", + "suggestions": [ + { + "name": "None" + }, + { + "name": "Proxy" + }, + { + "name": "Server" + } + ] + } + ], + "description": "Specifies that credentials stored in the Windows Credential Manager should be used for authentication when required for the specified target server type. If this parameter is not specified and a server requires authentication, then explicit credentials must be included by using the *Credential* or *ProxyCredential* parameters. This parameter is a flag parameter whose values can be added together to create the desired behavior." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Source", + "description": "Specifies the source location and the names of the files that you want to transfer. The source file names are paired with the corresponding destination file names. For example, the first file name specified in the *Source* parameter corresponds to the first file name in the *Destination* parameter, and the second file name in the *Source* parameter corresponds to the second file name in the *Destination* parameter. The *Source* and *Destination* parameters must have the same number of elements; otherwise, the command produces an error. You can use standard wildcard characters such as the asterisk (*) and the question mark (?). Or, you can use a range operator such as \"\\[a-r\\]\"." + }, + { + "name": "-Destination", + "description": "Specifies an array that contains the destination location and the names of the files that you want to transfer. The destination names are paired with the corresponding source file names. For example, the first file name specified in the *Source* parameter corresponds to the first file name in the *Destination* parameter, and the second file name in the *Source* parameter corresponds to the second file name in the *Destination* parameter. The *Source* and *Destination* parameters must have the same number of elements; otherwise, the command produces an error." + } + ], + "description": "Creates a BITS transfer job.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/start-dtcdiagnosticresourcemanager.json b/command-signatures/json/autogenerated/powershell/start-dtcdiagnosticresourcemanager.json new file mode 100644 index 00000000..ebd168fc --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/start-dtcdiagnosticresourcemanager.json @@ -0,0 +1,205 @@ +{ + "name": "Start-DtcDiagnosticResourceManager", + "options": [ + { + "name": "-Name", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": "-Port", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Port" + }, + { + "name": "-Name" + } + ], + "description": "Start-DtcDiagnosticResourceManager [[-Port] ] [[-Name] ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/start-job.json b/command-signatures/json/autogenerated/powershell/start-job.json index b051da33..40eacb36 100644 --- a/command-signatures/json/autogenerated/powershell/start-job.json +++ b/command-signatures/json/autogenerated/powershell/start-job.json @@ -11,7 +11,7 @@ "name": "System.Object[]" } ], - "description": "Specifies an array of arguments, or parameter values, for the script that is specified by the FilePath parameter or a command specified with the ScriptBlock parameter.\n" + "description": "Specifies an array of arguments, or parameter values, for the script that is specified by the FilePath parameter or a command specified with the ScriptBlock parameter." }, { "name": "-Authentication", @@ -20,41 +20,39 @@ "name": "System.Management.Automation.Runspaces.AuthenticationMechanism", "suggestions": [ { - "name": "Default" + "name": "Basic" }, { - "name": "Basic" + "name": "Credssp" }, { - "name": "Negotiate" + "name": "Default" }, { - "name": "NegotiateWithImplicitCredential" + "name": "Digest" }, { - "name": "Credssp" + "name": "Kerberos" }, { - "name": "Digest" + "name": "Negotiate" }, { - "name": "Kerberos" + "name": "NegotiateWithImplicitCredential" } - ], - "default": "Default" + ] } ], - "description": "Specifies the mechanism that is used to authenticate user credentials.\n" + "description": "Specifies the mechanism that is used to authenticate user credentials." }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to perform this action. If the Credential parameter isn't specified, the command uses the current user's credentials.\n" + "description": "Specifies a user account that has permission to perform this action. If the Credential parameter isn't specified, the command uses the current user's credentials." }, { "name": "-DefinitionName", @@ -64,7 +62,7 @@ } ], "isRequired": true, - "description": "Specifies the definition name of the job that this cmdlet starts. Use this parameter to start custom job types that have a definition name, such as scheduled jobs.\n" + "description": "Specifies the definition name of the job that this cmdlet starts. Use this parameter to start custom job types that have a definition name, such as scheduled jobs." }, { "name": "-DefinitionPath", @@ -73,7 +71,7 @@ "name": "System.String" } ], - "description": "Specifies path of the definition for the job that this cmdlet starts. Enter the definition path. The concatenation of the values of the DefinitionPath and DefinitionName parameters is the fully qualified path of the job definition. Use this parameter to start custom job types that have a definition path, such as scheduled jobs.\n" + "description": "Specifies path of the definition for the job that this cmdlet starts. Enter the definition path. The concatenation of the values of the DefinitionPath and DefinitionName parameters is the fully qualified path of the job definition. Use this parameter to start custom job types that have a definition path, such as scheduled jobs." }, { "name": "-FilePath", @@ -83,7 +81,7 @@ } ], "isRequired": true, - "description": "Specifies a local script that `Start-Job` runs as a background job. Enter the path and file name of the script or use the pipeline to send a script path to `Start-Job`. The script must be on the local computer or in a folder that the local computer can access.\n" + "description": "Specifies a local script that `Start-Job` runs as a background job. Enter the path and file name of the script or use the pipeline to send a script path to `Start-Job`. The script must be on the local computer or in a folder that the local computer can access." }, { "name": "-InitializationScript", @@ -92,7 +90,7 @@ "name": "System.Management.Automation.ScriptBlock" } ], - "description": "Specifies commands that run before the job starts. To create a script block, enclose the commands in curly braces (`{}`).\n" + "description": "Specifies commands that run before the job starts. To create a scriptblock, enclose the commands in curly braces (`{}`)." }, { "name": "-InputObject", @@ -101,7 +99,7 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies input to the command. Enter a variable that contains the objects, or type a command or expression that generates the objects.\n" + "description": "Specifies input to the command. Enter a variable that contains the objects, or type a command or expression that generates the objects." }, { "name": [ @@ -115,7 +113,7 @@ } ], "isRequired": true, - "description": "Specifies a local script that this cmdlet runs as a background job. Enter the path of a script on the local computer.\n" + "description": "Specifies a local script that this cmdlet runs as a background job. Enter the path of a script on the local computer." }, { "name": "-Name", @@ -124,7 +122,7 @@ "name": "System.String" } ], - "description": "Specifies a friendly name for the new job. You can use the name to identify the job to other job cmdlets, such as the `Stop-Job` cmdlet.\n" + "description": "Specifies a friendly name for the new job. You can use the name to identify the job to other job cmdlets, such as the `Stop-Job` cmdlet." }, { "name": "-PSVersion", @@ -133,11 +131,11 @@ "name": "System.Version" } ], - "description": "Specifies a version of PowerShell to use for running the job. When the value of PSVersion is 5.1 The job is run in a Windows PowerShell 5.1 session. For any other value, the job is run using the current version of PowerShell.\n" + "description": "Specifies a version of PowerShell to use for running the job. When the value of PSVersion is 5.1 The job is run in a Windows PowerShell 5.1 session. For any other value, the job is run using the current version of PowerShell." }, { "name": "-RunAs32", - "description": "Beginning with PowerShell 7, the RunAs32 parameter doesn't work on 64-bit PowerShell (`pwsh`). If RunAs32 is specified in 64-bit PowerShell, `Start-Job` throws a terminating exception error. To start a 32-bit PowerShell (`pwsh`) process with RunAs32 , you need to have the 32-bit PowerShell installed.\n" + "description": "Beginning with PowerShell 7, the RunAs32 parameter doesn't work on 64-bit PowerShell (`pwsh`). If RunAs32 is specified in 64-bit PowerShell, `Start-Job` throws a terminating exception error. To start a 32-bit PowerShell (`pwsh`) process with RunAs32, you need to have the 32-bit PowerShell installed." }, { "name": [ @@ -150,7 +148,7 @@ } ], "isRequired": true, - "description": "Specifies the commands to run in the background job. To create a script block, enclose the commands in curly braces (`{}`). Use the `$input` automatic variable to access the value of the InputObject parameter. This parameter is required." + "description": "Specifies the commands to run in the background job. To create a scriptblock, enclose the commands in curly braces (`{}`). Use the `$input` automatic variable to access the value of the InputObject parameter. This parameter is required." }, { "name": "-Type", @@ -159,17 +157,16 @@ "name": "System.String" } ], - "description": "Specifies the custom type for jobs started by `Start-Job`. Enter a custom job type name, such as PSScheduledJob for scheduled jobs or PSWorkflowJob for workflows jobs. This parameter isn't valid for standard background jobs.\n" + "description": "Specifies the custom type for jobs started by `Start-Job`. Enter a custom job type name, such as PSScheduledJob for scheduled jobs or PSWorkflowJob for workflows jobs. This parameter isn't valid for standard background jobs." }, { "name": "-WorkingDirectory", "args": [ { - "name": "System.String", - "default": "$HOME on Unix (macOS, Linux) and $HOME\\Documents on Windows" + "name": "System.String" } ], - "description": "Specifies the initial working directory of the background job. If the parameter isn't specified, the job runs from the default location. The default location is the current working directory of the caller that started the job.\n" + "description": "Specifies the initial working directory of the background job. If the parameter isn't specified, the job runs from the default location. The default location is the current working directory of the caller that started the job." }, { "name": [ @@ -351,7 +348,7 @@ }, { "name": "-Type", - "description": "Specifies the custom type for jobs started by `Start-Job`. Enter a custom job type name, such as PSScheduledJob for scheduled jobs or PSWorkflowJob for workflows jobs. This parameter isn't valid for standard background jobs.\n" + "description": "Specifies the custom type for jobs started by `Start-Job`. Enter a custom job type name, such as PSScheduledJob for scheduled jobs or PSWorkflowJob for workflows jobs. This parameter isn't valid for standard background jobs." } ], "description": "Starts a PowerShell background job.", diff --git a/command-signatures/json/autogenerated/powershell/start-osuninstall.json b/command-signatures/json/autogenerated/powershell/start-osuninstall.json new file mode 100644 index 00000000..f02aa936 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/start-osuninstall.json @@ -0,0 +1,266 @@ +{ + "name": "Start-OSUninstall", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-NoRestart", + "description": "Suppresses the prompt to restart and also requires a manual restart." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Windows gives a user the ability to uninstall and roll back to a previous version of Windows. You can use DISM to initiate an uninstall.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/start-process.json b/command-signatures/json/autogenerated/powershell/start-process.json index 681c02a6..1e780e59 100644 --- a/command-signatures/json/autogenerated/powershell/start-process.json +++ b/command-signatures/json/autogenerated/powershell/start-process.json @@ -11,7 +11,14 @@ "name": "System.String[]" } ], - "description": "Specifies parameters or parameter values to use when this cmdlet starts the process. Arguments can be accepted as a single string with the arguments separated by spaces, or as an array of strings separated by commas. The cmdlet joins the array into a single string with each element of the array separated by a single space.\n" + "description": "Specifies parameters or parameter values to use when this cmdlet starts the process. Arguments can be accepted as a single string with the arguments separated by spaces, or as an array of strings separated by commas. The cmdlet joins the array into a single string with each element of the array separated by a single space." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": [ @@ -20,11 +27,19 @@ ], "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to perform this action. By default, the cmdlet uses the credentials of the current user.\n" + "description": "Specifies a user account that has permission to perform this action. By default, the cmdlet uses the credentials of the current user." + }, + { + "name": "-Environment", + "args": [ + { + "name": "System.Collections.Hashtable" + } + ], + "description": "Specifies one or more environment variables to override for the process as a hash table. Specify the name of an environment variable as a key in the hash table and the desired value. To unset an environment variable, specify its value as `$null`." }, { "name": [ @@ -38,21 +53,21 @@ } ], "isRequired": true, - "description": "Specifies the optional path and filename of the program that runs in the process. Enter the name of an executable file or of a document, such as a `.txt` or `.doc` file, that's associated with a program on the computer. This parameter is required.\n" + "description": "Specifies the optional path and filename of the program that runs in the process. Enter the name of an executable file or of a document, such as a `.txt` or `.doc` file, that's associated with a program on the computer. This parameter is required." }, { "name": [ "-LoadUserProfile", "-Lup" ], - "description": "Indicates that this cmdlet loads the Windows user profile stored in the `HKEY_USERS` registry key for the current user. The parameter doesn't apply to non-Windows systems.\n" + "description": "Indicates that this cmdlet loads the Windows user profile stored in the `HKEY_USERS` registry key for the current user. The parameter doesn't apply to non-Windows systems." }, { "name": [ "-NoNewWindow", "-nnw" ], - "description": "Start the new process in the current console window. By default on Windows, PowerShell opens a new window. On non-Windows systems, you never get a new window.\n" + "description": "Start the new process in the current console window. By default on Windows, PowerShell opens a new window. On non-Windows systems, you never get a new window." }, { "name": "-PassThru", @@ -96,7 +111,7 @@ }, { "name": "-UseNewEnvironment", - "description": "Indicates that this cmdlet uses new environment variables specified for the process. By default, the started process runs with the environment variables inherited from the parent process.\n" + "description": "Indicates that this cmdlet uses new environment variables specified for the process. By default, the started process runs with the environment variables inherited from the parent process." }, { "name": "-Verb", @@ -105,12 +120,19 @@ "name": "System.String" } ], - "description": "Specifies a verb to use when this cmdlet starts the process. The verbs that are available are determined by the filename extension of the file that runs in the process.\n" + "description": "Specifies a verb to use when this cmdlet starts the process. The verbs that are available are determined by the filename extension of the file that runs in the process." }, { "name": "-Wait", "description": "Indicates that this cmdlet waits for the specified process and its descendants to complete before accepting more input. This parameter suppresses the command prompt or retains the window until the processes finish." }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, { "name": "-WindowStyle", "args": [ @@ -118,21 +140,21 @@ "name": "System.Diagnostics.ProcessWindowStyle", "suggestions": [ { - "name": "Normal" + "name": "Hidden" }, { - "name": "Hidden" + "name": "Maximized" }, { "name": "Minimized" }, { - "name": "Maximized" + "name": "Normal" } ] } ], - "description": "Specifies the state of the window that's used for the new process. The default value is `Normal`. The acceptable values for this parameter are:\n" + "description": "Specifies the state of the window that's used for the new process. The default value is `Normal`. The acceptable values for this parameter are:" }, { "name": "-WorkingDirectory", @@ -141,21 +163,7 @@ "name": "System.String" } ], - "description": "Specifies the location that the new process should start in.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, - { - "name": [ - "-WhatIf", - "-wi" - ], - "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run.\n" + "description": "Specifies the location that the new process should start in." }, { "name": [ @@ -331,11 +339,11 @@ "args": [ { "name": "-FilePath", - "description": "Specifies the optional path and filename of the program that runs in the process. Enter the name of an executable file or of a document, such as a `.txt` or `.doc` file, that's associated with a program on the computer. This parameter is required.\n" + "description": "Specifies the optional path and filename of the program that runs in the process. Enter the name of an executable file or of a document, such as a `.txt` or `.doc` file, that's associated with a program on the computer. This parameter is required." }, { "name": "-ArgumentList", - "description": "Specifies parameters or parameter values to use when this cmdlet starts the process. Arguments can be accepted as a single string with the arguments separated by spaces, or as an array of strings separated by commas. The cmdlet joins the array into a single string with each element of the array separated by a single space.\n" + "description": "Specifies parameters or parameter values to use when this cmdlet starts the process. Arguments can be accepted as a single string with the arguments separated by spaces, or as an array of strings separated by commas. The cmdlet joins the array into a single string with each element of the array separated by a single space." } ], "description": "Starts one or more processes on the local computer.", diff --git a/command-signatures/json/autogenerated/powershell/start-refsdedupjob.json b/command-signatures/json/autogenerated/powershell/start-refsdedupjob.json new file mode 100644 index 00000000..c2049893 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/start-refsdedupjob.json @@ -0,0 +1,308 @@ +{ + "name": "Start-ReFSDedupJob", + "options": [ + { + "name": "-CompressionChunkSize", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": "-CompressionFormat", + "args": [ + { + "name": "Format", + "suggestions": [ + { + "name": "Unknown" + }, + { + "name": "Uncompressed" + }, + { + "name": "LZ4" + }, + { + "name": "ZSTD" + } + ] + } + ] + }, + { + "name": "-CompressionLevel", + "args": [ + { + "name": "uint16" + } + ] + }, + { + "name": "-CompressionTuning", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": "-ConcurrentOpenFiles", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": "-CpuPercentage", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": "-DecompressionTuning", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": "-Duration", + "args": [ + { + "name": "timespan" + } + ] + }, + { + "name": "-ExcludeFileExtension", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-ExcludeFolder", + "args": [ + { + "name": "string[]" + } + ] + }, + { + "name": "-FullRun" + }, + { + "name": "-MinimumLastModifiedTimeHours", + "args": [ + { + "name": "int" + } + ] + }, + { + "name": "-RecompressionTuning", + "args": [ + { + "name": "uint32" + } + ] + }, + { + "name": "-Volume", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Start-ReFSDedupJob [-Volume] [-Duration ] [-FullRun] [-CpuPercentage ] [-ConcurrentOpenFiles ] [-MinimumLastModifiedTimeHours ] [-ExcludeFileExtension ] [-ExcludeFolder ] [-CompressionFormat ] [-CompressionLevel ] [-CompressionChunkSize ] [-CompressionTuning ] [-RecompressionTuning ] [-DecompressionTuning ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/start-service.json b/command-signatures/json/autogenerated/powershell/start-service.json new file mode 100644 index 00000000..ec201791 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/start-service.json @@ -0,0 +1,255 @@ +{ + "name": "Start-Service", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-DisplayName", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the display names of the services to start. Wildcard characters are permitted." + }, + { + "name": "-Exclude", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies services that this cmdlet omits. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as `s*`. Wildcard characters are permitted." + }, + { + "name": "-Include", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies services that this cmdlet starts. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as `s*`. Wildcard characters are permitted." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "System.ServiceProcess.ServiceController[]" + } + ], + "isRequired": true, + "description": "Specifies ServiceController objects representing the services to be started. Enter a variable that contains the objects, or type a command or expression that gets the objects." + }, + { + "name": [ + "-Name", + "-ServiceName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the service names for the service to be started." + }, + { + "name": "-PassThru", + "description": "Returns an object that represents the service. By default, this cmdlet does not generate any output." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name" + } + ], + "description": "Starts one or more stopped services.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/start-sleep.json b/command-signatures/json/autogenerated/powershell/start-sleep.json index 8f962232..4bcf8270 100644 --- a/command-signatures/json/autogenerated/powershell/start-sleep.json +++ b/command-signatures/json/autogenerated/powershell/start-sleep.json @@ -25,7 +25,7 @@ } ], "isRequired": true, - "description": "Specifies how long the resource sleeps in milliseconds. The parameter can be abbreviated as m ." + "description": "Specifies how long the resource sleeps in milliseconds. The parameter can be abbreviated as m." }, { "name": "-Seconds", @@ -35,7 +35,7 @@ } ], "isRequired": true, - "description": "Specifies how long the resource sleeps in seconds. You can omit the parameter name or you can abbreviate it as s . Beginning in PowerShell 6.2.0, this parameter now accepts fractional values." + "description": "Specifies how long the resource sleeps in seconds. You can omit the parameter name or you can abbreviate it as s. Beginning in PowerShell 6.2.0, this parameter now accepts fractional values." }, { "name": [ @@ -211,7 +211,7 @@ "args": [ { "name": "-Seconds", - "description": "Specifies how long the resource sleeps in seconds. You can omit the parameter name or you can abbreviate it as s . Beginning in PowerShell 6.2.0, this parameter now accepts fractional values." + "description": "Specifies how long the resource sleeps in seconds. You can omit the parameter name or you can abbreviate it as s. Beginning in PowerShell 6.2.0, this parameter now accepts fractional values." } ], "description": "Suspends the activity in a script or session for the specified period of time.", diff --git a/command-signatures/json/autogenerated/powershell/start-threadjob.json b/command-signatures/json/autogenerated/powershell/start-threadjob.json index c5bb110a..adefcd59 100644 --- a/command-signatures/json/autogenerated/powershell/start-threadjob.json +++ b/command-signatures/json/autogenerated/powershell/start-threadjob.json @@ -8,7 +8,7 @@ "name": "System.Object[]" } ], - "description": "Specifies an array of arguments, or parameter values, for the script that is specified by the FilePath or ScriptBlock parameters. ArgumentList must be the last parameter on the command line. All the values that follow the parameter name are interpreted values in the argument list." + "description": "Specifies an array of arguments, or parameter values, for the script that is specified by the FilePath or ScriptBlock parameters." }, { "name": "-FilePath", @@ -18,7 +18,7 @@ } ], "isRequired": true, - "description": "Specifies a script file to run as a background job. Enter the path and filename of the script. The script must be on the local computer or in a folder that the local computer can access.\n" + "description": "Specifies a script file to run as a background job. Enter the path and filename of the script. The script must be on the local computer or in a folder that the local computer can access." }, { "name": "-InitializationScript", @@ -27,7 +27,7 @@ "name": "System.Management.Automation.ScriptBlock" } ], - "description": "Specifies commands that run before the job starts. Enclose the commands in braces (`{}`) to create a script block.\n" + "description": "Specifies commands that run before the job starts. Enclose the commands in braces (`{}`) to create a scriptblock." }, { "name": "-InputObject", @@ -36,7 +36,7 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies the objects used as input to the script block. It also allows for pipeline input. Use the `$input` automatic variable in the script block to access the input objects." + "description": "Specifies the objects used as input to the scriptblock. It also allows for pipeline input. Use the `$input` automatic variable in the scriptblock to access the input objects." }, { "name": "-Name", @@ -45,7 +45,7 @@ "name": "System.String" } ], - "description": "Specifies a friendly name for the new job. You can use the name to identify the job to other job cmdlets, such as the `Stop-Job` cmdlet.\n" + "description": "Specifies a friendly name for the new job. You can use the name to identify the job to other job cmdlets, such as the `Stop-Job` cmdlet." }, { "name": "-ScriptBlock", @@ -55,7 +55,7 @@ } ], "isRequired": true, - "description": "Specifies the commands to run in the background job. Enclose the commands in braces (`{}`) to create a script block. Use the `$Input` automatic variable to access the value of the InputObject parameter. This parameter is required." + "description": "Specifies the commands to run in the background job. Enclose the commands in braces (`{}`) to create a scriptblock. Use the `$input` automatic variable to access the value of the InputObject parameter. This parameter is required." }, { "name": "-StreamingHost", @@ -70,11 +70,10 @@ "name": "-ThrottleLimit", "args": [ { - "name": "System.Int32", - "default": "5" + "name": "System.Int32" } ], - "description": "This parameter limits the number of jobs running at one time. As jobs are started, they are queued and wait until a thread is available in the thread pool to run the job. The default limit is 5 threads.\n" + "description": "This parameter limits the number of jobs running at one time. As jobs are started, they are queued and wait until a thread is available in the thread pool to run the job. The default limit is 5 threads." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/start-transaction.json b/command-signatures/json/autogenerated/powershell/start-transaction.json new file mode 100644 index 00000000..90e59dbd --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/start-transaction.json @@ -0,0 +1,227 @@ +{ + "name": "Start-Transaction", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Independent" + }, + { + "name": "-RollbackPreference", + "args": [ + { + "name": "RollbackSeverity", + "suggestions": [ + { + "name": "Error" + }, + { + "name": "TerminatingError" + }, + { + "name": "Never" + } + ] + } + ] + }, + { + "name": [ + "-Timeout", + "-TimeoutMins" + ], + "args": [ + { + "name": "int" + } + ] + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Start-Transaction [-Timeout ] [-Independent] [-RollbackPreference ] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/start-transcript.json b/command-signatures/json/autogenerated/powershell/start-transcript.json index 3121e30f..83ff34ba 100644 --- a/command-signatures/json/autogenerated/powershell/start-transcript.json +++ b/command-signatures/json/autogenerated/powershell/start-transcript.json @@ -5,6 +5,13 @@ "name": "-Append", "description": "Indicates that this cmdlet adds the new transcript to the end of an existing file. Use the Path parameter to specify the file." }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Force", "description": "Allows the cmdlet to append the transcript to an existing read-only file. When used on a read-only file, the cmdlet changes the file permission to read-write. The cmdlet can't override security restrictions when this parameter is used." @@ -40,7 +47,7 @@ "name": "System.String" } ], - "description": "Specifies a specific path and folder in which to save a transcript. PowerShell automatically assigns the transcript name." + "description": "Specifies a specific path and folder in which to save a transcript. PowerShell automatically assigns the transcript name. If you use a relative path, the path is relative to your `Documents` directory on Windows. On Linux and macOS, the path is relative to your home directory." }, { "name": "-Path", @@ -49,19 +56,12 @@ "name": "System.String" } ], - "description": "Specifies a location to the transcript file. Enter a path to a `.txt` file. Wildcards aren't permitted. If any of the directories in the path don't exist, the command fails.\n" + "description": "Specifies a location to the transcript file. Enter a path to a `.txt` file. Wildcards aren't permitted. If any of the directories in the path don't exist, the command fails." }, { "name": "-UseMinimalHeader", "description": "Prepend a short header to the transcript, instead of the detailed header included by default. This parameter was added in PowerShell 6.2." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/stop-computer.json b/command-signatures/json/autogenerated/powershell/stop-computer.json index 713dd5f6..563cfdea 100644 --- a/command-signatures/json/autogenerated/powershell/stop-computer.json +++ b/command-signatures/json/autogenerated/powershell/stop-computer.json @@ -14,65 +14,63 @@ "name": "System.String[]" } ], - "description": "Specifies the computers to stop. The default is the local computer.\n" + "description": "Specifies the computers to stop. The default is the local computer." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to do this action. The default is the current user.\n" + "description": "Specifies a user account that has permission to do this action. The default is the current user." }, { "name": "-Force", "description": "Forces an immediate shut down of the computer." }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, { "name": "-WsmanAuthentication", "args": [ { "name": "System.String", "suggestions": [ - { - "name": "Default" - }, { "name": "Basic" }, { - "name": "Negotiate" + "name": "CredSSP" }, { - "name": "CredSSP" + "name": "Default" }, { "name": "Digest" }, { "name": "Kerberos" + }, + { + "name": "Negotiate" } - ], - "default": "Default" + ] } ], - "description": "Specifies the mechanism that is used to authenticate the user credentials when this cmdlet uses the WSMan protocol. The default value is Default .\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, - { - "name": [ - "-WhatIf", - "-wi" - ], - "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + "description": "Specifies the mechanism that is used to authenticate the user credentials when this cmdlet uses the WSMan protocol. The default value is Default." }, { "name": [ @@ -248,11 +246,11 @@ "args": [ { "name": "-ComputerName", - "description": "Specifies the computers to stop. The default is the local computer.\n" + "description": "Specifies the computers to stop. The default is the local computer." }, { "name": "-Credential", - "description": "Specifies a user account that has permission to do this action. The default is the current user.\n" + "description": "Specifies a user account that has permission to do this action. The default is the current user." } ], "description": "Stops (shuts down) local and remote computers.", diff --git a/command-signatures/json/autogenerated/powershell/stop-dtcdiagnosticresourcemanager.json b/command-signatures/json/autogenerated/powershell/stop-dtcdiagnosticresourcemanager.json new file mode 100644 index 00000000..2f00d9c8 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/stop-dtcdiagnosticresourcemanager.json @@ -0,0 +1,210 @@ +{ + "name": "Stop-DtcDiagnosticResourceManager", + "options": [ + { + "name": "-InstanceId", + "args": [ + { + "name": "guid" + } + ] + }, + { + "name": "-Job", + "args": [ + { + "name": "DtcDiagnosticResourceManagerJob" + } + ] + }, + { + "name": "-Name", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InstanceId-Or-Job-Or-Name" + } + ], + "description": "Stop-DtcDiagnosticResourceManager [[-Job] ] [] Stop-DtcDiagnosticResourceManager [[-Name] ] [] Stop-DtcDiagnosticResourceManager [[-InstanceId] ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/stop-job.json b/command-signatures/json/autogenerated/powershell/stop-job.json index db3367ef..a5c054bd 100644 --- a/command-signatures/json/autogenerated/powershell/stop-job.json +++ b/command-signatures/json/autogenerated/powershell/stop-job.json @@ -1,6 +1,13 @@ { "name": "Stop-Job", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Filter", "args": [ @@ -9,36 +16,33 @@ } ], "isRequired": true, - "description": "Specifies a hash table of conditions. This cmdlet stops jobs that satisfy every condition. Enter a hash table where the keys are job properties and the values are job property values.\n" + "description": "Specifies a hash table of conditions. This cmdlet stops jobs that satisfy every condition. Enter a hash table where the keys are job properties and the values are job property values." }, { "name": "-Id", "args": [ { - "name": "System.Int32[]", - "default": "All jobs" + "name": "System.Int32[]" } ], "isRequired": true, - "description": "Specifies the IDs of jobs that this cmdlet stops. The default is all jobs in the current session.\n" + "description": "Specifies the IDs of jobs that this cmdlet stops. The default is all jobs in the current session." }, { "name": "-InstanceId", "args": [ { - "name": "System.Guid[]", - "default": "All jobs" + "name": "System.Guid[]" } ], "isRequired": true, - "description": "Specifies the instance IDs of jobs that this cmdlet stops. The default is all jobs.\n" + "description": "Specifies the instance IDs of jobs that this cmdlet stops. The default is all jobs." }, { "name": "-Job", "args": [ { - "name": "System.Management.Automation.Job[]", - "default": "All jobs" + "name": "System.Management.Automation.Job[]" } ], "isRequired": true, @@ -48,12 +52,11 @@ "name": "-Name", "args": [ { - "name": "System.String[]", - "default": "All jobs" + "name": "System.String[]" } ], "isRequired": true, - "description": "Specifies friendly names of jobs that this cmdlet stops. Enter the job names in a comma-separated list or use wildcard characters (`*`) to enter a job name pattern. By default, `Stop-Job` stops all jobs created in the current session.\n" + "description": "Specifies friendly names of jobs that this cmdlet stops. Enter the job names in a comma-separated list or use wildcard characters (`*`) to enter a job name pattern. By default, `Stop-Job` stops all jobs created in the current session." }, { "name": "-PassThru", @@ -66,51 +69,43 @@ "name": "System.Management.Automation.JobState", "suggestions": [ { - "name": "NotStarted" + "name": "AtBreakpoint" }, { - "name": "Running" + "name": "Blocked" }, { "name": "Completed" }, { - "name": "Failed" + "name": "Disconnected" }, { - "name": "Stopped" + "name": "Failed" }, { - "name": "Blocked" + "name": "NotStarted" }, { - "name": "Suspended" + "name": "Running" }, { - "name": "Disconnected" + "name": "Stopped" }, { - "name": "Suspending" + "name": "Stopping" }, { - "name": "Stopping" + "name": "Suspended" }, { - "name": "AtBreakpoint" + "name": "Suspending" } - ], - "default": "All jobs" + ] } ], "isRequired": true, - "description": "Specifies a job state. This cmdlet stops only jobs in the specified state. The acceptable values for this parameter are:\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies a job state. This cmdlet stops only jobs in the specified state. The acceptable values for this parameter are:" }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/stop-process.json b/command-signatures/json/autogenerated/powershell/stop-process.json index 2e2a3dcf..d16196a3 100644 --- a/command-signatures/json/autogenerated/powershell/stop-process.json +++ b/command-signatures/json/autogenerated/powershell/stop-process.json @@ -1,9 +1,16 @@ { "name": "Stop-Process", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Force", - "description": "Stops the specified processes without prompting for confirmation. By default, `Stop-Process` prompts for confirmation before stopping any process that is not owned by the current user.\n" + "description": "Stops the specified processes without prompting for confirmation. By default, `Stop-Process` prompts for confirmation before stopping any process that is not owned by the current user." }, { "name": "-Id", @@ -42,13 +49,6 @@ "name": "-PassThru", "description": "Returns an object that represents the process. By default, this cmdlet does not generate any output." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/stop-refsdedupjob.json b/command-signatures/json/autogenerated/powershell/stop-refsdedupjob.json new file mode 100644 index 00000000..e02ecd6d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/stop-refsdedupjob.json @@ -0,0 +1,195 @@ +{ + "name": "Stop-ReFSDedupJob", + "options": [ + { + "name": "-Volume", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Stop-ReFSDedupJob [-Volume] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/stop-service.json b/command-signatures/json/autogenerated/powershell/stop-service.json new file mode 100644 index 00000000..6f6d43e8 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/stop-service.json @@ -0,0 +1,263 @@ +{ + "name": "Stop-Service", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-DisplayName", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the display names of the services to stop. Wildcard characters are permitted." + }, + { + "name": "-Exclude", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies services that this cmdlet omits. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as s*. Wildcard characters are permitted." + }, + { + "name": "-Force", + "description": "Forces the cmdlet to stop a service even if that service has dependent services." + }, + { + "name": "-Include", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies services that this cmdlet stops. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as s*. Wildcard characters are permitted." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "System.ServiceProcess.ServiceController[]" + } + ], + "isRequired": true, + "description": "Specifies ServiceController objects that represent the services to stop. Enter a variable that contains the objects, or type a command or expression that gets the objects." + }, + { + "name": [ + "-Name", + "-ServiceName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the service names of the services to stop. Wildcard characters are permitted." + }, + { + "name": "-NoWait", + "description": "Indicates that this cmdlet uses the no wait option." + }, + { + "name": "-PassThru", + "description": "Returns an object that represents the service. By default, this cmdlet does not generate any output." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name" + } + ], + "description": "Stops one or more running services.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/stop-transcript.json b/command-signatures/json/autogenerated/powershell/stop-transcript.json index 6dc10b93..8320bcc6 100644 --- a/command-signatures/json/autogenerated/powershell/stop-transcript.json +++ b/command-signatures/json/autogenerated/powershell/stop-transcript.json @@ -1,6 +1,20 @@ { "name": "Stop-Transcript", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, { "name": [ "-Debug", diff --git a/command-signatures/json/autogenerated/powershell/suspend-bitstransfer.json b/command-signatures/json/autogenerated/powershell/suspend-bitstransfer.json new file mode 100644 index 00000000..ed6a941b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/suspend-bitstransfer.json @@ -0,0 +1,214 @@ +{ + "name": "Suspend-BitsTransfer", + "options": [ + { + "name": [ + "-BitsJob", + "-b" + ], + "args": [ + { + "name": "BitsJob[]" + } + ], + "isRequired": true, + "description": "Specifies the BITS transfer jobs to suspend. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as Get-BitsTransfer." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-BitsJob", + "description": "Specifies the BITS transfer jobs to suspend. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as Get-BitsTransfer." + } + ], + "description": "Suspends a BITS transfer job.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/suspend-refsdedupschedule.json b/command-signatures/json/autogenerated/powershell/suspend-refsdedupschedule.json new file mode 100644 index 00000000..590d96f4 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/suspend-refsdedupschedule.json @@ -0,0 +1,195 @@ +{ + "name": "Suspend-ReFSDedupSchedule", + "options": [ + { + "name": "-Volume", + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Volume" + } + ], + "description": "Suspend-ReFSDedupSchedule [-Volume] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/suspend-service.json b/command-signatures/json/autogenerated/powershell/suspend-service.json new file mode 100644 index 00000000..306c3f4a --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/suspend-service.json @@ -0,0 +1,255 @@ +{ + "name": "Suspend-Service", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-DisplayName", + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the display names of the services to be suspended. Wildcard characters are permitted." + }, + { + "name": "-Exclude", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies services to omit from the specified services. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as \"s*\". Wildcard characters are permitted." + }, + { + "name": "-Include", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies services to suspend. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as \"s*\". Wildcard characters are permitted." + }, + { + "name": "-InputObject", + "args": [ + { + "name": "System.ServiceProcess.ServiceController[]" + } + ], + "isRequired": true, + "description": "Specifies ServiceController objects that represent the services to suspend. Enter a variable that contains the objects, or type a command or expression that gets the objects." + }, + { + "name": [ + "-Name", + "-ServiceName" + ], + "args": [ + { + "name": "System.String[]" + } + ], + "isRequired": true, + "description": "Specifies the service names of the services to suspend. Wildcard characters are permitted." + }, + { + "name": "-PassThru", + "description": "Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-InputObject-Or-Name" + } + ], + "description": "Suspends (pauses) one or more running services.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/switch-certificate.json b/command-signatures/json/autogenerated/powershell/switch-certificate.json new file mode 100644 index 00000000..49b237dc --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/switch-certificate.json @@ -0,0 +1,229 @@ +{ + "name": "Switch-Certificate", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-NewCert", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.Certificate" + } + ], + "isRequired": true, + "description": "Specifies an X509 certificate or a certificate path for the certificate that replaces the certificate specified with the OldCert parameter." + }, + { + "name": "-NotifyOnly", + "description": "Creates a replacement certificate notification without replacing the NewCert parameter with the OldCert parameter. This mode is useful when testing a script that was registered with the `New-CertificateNotificationTask` cmdlet." + }, + { + "name": "-OldCert", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.Certificate" + } + ], + "isRequired": true, + "description": "Specifies an X509 certificate or a certificate path in the certificate provider for the certificate to be replaced." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-OldCert", + "description": "Specifies an X509 certificate or a certificate path in the certificate provider for the certificate to be replaced." + }, + { + "name": "-NewCert", + "description": "Specifies an X509 certificate or a certificate path for the certificate that replaces the certificate specified with the OldCert parameter." + } + ], + "description": "Marks one certificate as having been replaced by another certificate.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/tee-object.json b/command-signatures/json/autogenerated/powershell/tee-object.json index f96c1de0..0b0f5b95 100644 --- a/command-signatures/json/autogenerated/powershell/tee-object.json +++ b/command-signatures/json/autogenerated/powershell/tee-object.json @@ -3,7 +3,7 @@ "options": [ { "name": "-Append", - "description": "Indicates that the cmdlet appends the output to the specified file. Without this parameter, the new content replaces any existing content in the file without warning.\n" + "description": "Indicates that the cmdlet appends the output to the specified file. Without this parameter, the new content replaces any existing content in the file without warning." }, { "name": "-Encoding", @@ -12,37 +12,42 @@ "name": "System.Text.Encoding", "suggestions": [ { - "name": "ASCII" + "name": "ansi" }, { - "name": "BigEndianUnicode" + "name": "ascii" }, { - "name": "OEM" + "name": "bigendianunicode" }, { - "name": "Unicode" + "name": "bigendianutf32" }, { - "name": "UTF7" + "name": "oem" }, { - "name": "UTF8" + "name": "unicode" }, { - "name": "UTF8BOM" + "name": "utf32" }, { - "name": "UTF8NoBOM" + "name": "utf7" }, { - "name": "UTF32" + "name": "utf8" + }, + { + "name": "utf8BOM" + }, + { + "name": "utf8NoBOM" } - ], - "default": "UTF8NoBOM" + ] } ], - "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`.\n" + "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`." }, { "name": [ @@ -55,7 +60,7 @@ } ], "isRequired": true, - "description": "Specifies a file that this cmdlet saves the object to Wildcard characters are permitted, but must resolve to a single file.\n" + "description": "Specifies a file that this cmdlet saves the object to Wildcard characters are permitted, but must resolve to a single file." }, { "name": "-InputObject", @@ -64,7 +69,7 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies the object to be saved and displayed. Enter a variable that contains the objects or type a command or expression that gets the objects. You can also pipe an object to `Tee-Object`.\n" + "description": "Specifies the object to be saved and displayed. Enter a variable that contains the objects or type a command or expression that gets the objects. You can also pipe an object to `Tee-Object`." }, { "name": [ @@ -78,7 +83,7 @@ } ], "isRequired": true, - "description": "Specifies a file that this cmdlet saves the object to. Unlike FilePath , the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + "description": "Specifies a file that this cmdlet saves the object to. Unlike FilePath, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Variable", @@ -264,38 +269,44 @@ "args": [ { "name": "-FilePath", - "description": "Specifies a file that this cmdlet saves the object to Wildcard characters are permitted, but must resolve to a single file.\n" + "description": "Specifies a file that this cmdlet saves the object to Wildcard characters are permitted, but must resolve to a single file." }, { "name": "-Encoding", - "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`.\n", + "description": "Specifies the type of encoding for the target file. The default value is `utf8NoBOM`.", "suggestions": [ { - "name": "ASCII" + "name": "ansi" + }, + { + "name": "ascii" + }, + { + "name": "bigendianunicode" }, { - "name": "BigEndianUnicode" + "name": "bigendianutf32" }, { - "name": "OEM" + "name": "oem" }, { - "name": "Unicode" + "name": "unicode" }, { - "name": "UTF7" + "name": "utf32" }, { - "name": "UTF8" + "name": "utf7" }, { - "name": "UTF8BOM" + "name": "utf8" }, { - "name": "UTF8NoBOM" + "name": "utf8BOM" }, { - "name": "UTF32" + "name": "utf8NoBOM" } ] } diff --git a/command-signatures/json/autogenerated/powershell/test-certificate.json b/command-signatures/json/autogenerated/powershell/test-certificate.json new file mode 100644 index 00000000..f36974e0 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/test-certificate.json @@ -0,0 +1,249 @@ +{ + "name": "Test-Certificate", + "options": [ + { + "name": "-AllowUntrustedRoot", + "description": "Specifies whether the root certificate is required to be trusted in chain building. When this parameter is used, the certificate chain is built but an untrusted root is allowed. Other errors are still verified against in this case, such as expired. If this parameter is not specified, then revocation status is checked by default." + }, + { + "name": [ + "-Cert", + "-PsPath" + ], + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.Certificate" + } + ], + "isRequired": true, + "description": "Specifies the certificate to test. Either the certificate object or a path to the certificate in a certificate store can be specified." + }, + { + "name": "-DNSName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the DNS name to verify as valid for the certificate." + }, + { + "name": "-EKU", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "Specifies a list of enhanced key usage (EKU) object identifiers to verify for the certificate chain." + }, + { + "name": "-Policy", + "args": [ + { + "name": "Microsoft.CertificateServices.Commands.TestCertificatePolicy", + "suggestions": [ + { + "name": "BASE" + }, + { + "name": "SSL" + }, + { + "name": "AUTHENTICODE" + }, + { + "name": "NTAUTH" + } + ] + } + ], + "description": "Specifies the policies that will be applied to verify the certificate. The acceptable values for this parameter are: `AUTHENTICODE`, `BASE`, `NTAUTH`, and `SSL`. If this parameter is not specified, then the `BASE` policy is used." + }, + { + "name": "-User", + "description": "Specifies whether the user or machine context is used to test the certificate. If this parameter is not specified, then the machine context is used." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Cert", + "description": "Specifies the certificate to test. Either the certificate object or a path to the certificate in a certificate store can be specified." + } + ], + "description": "Verifies a certificate according to the input parameters.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/test-computersecurechannel.json b/command-signatures/json/autogenerated/powershell/test-computersecurechannel.json new file mode 100644 index 00000000..fa77eddf --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/test-computersecurechannel.json @@ -0,0 +1,213 @@ +{ + "name": "Test-ComputerSecureChannel", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": "-Credential", + "args": [ + { + "name": "pscredential" + } + ] + }, + { + "name": "-Repair" + }, + { + "name": "-Server", + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Test-ComputerSecureChannel [-Repair] [-Server ] [-Credential ] [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/test-connection.json b/command-signatures/json/autogenerated/powershell/test-connection.json index 5a5c76b3..502f099b 100644 --- a/command-signatures/json/autogenerated/powershell/test-connection.json +++ b/command-signatures/json/autogenerated/powershell/test-connection.json @@ -10,8 +10,7 @@ ], "args": [ { - "name": "System.Int32", - "default": "32" + "name": "System.Int32" } ], "description": "Specifies the size, in bytes, of the buffer sent with this command. The default value is 32." @@ -20,8 +19,7 @@ "name": "-Count", "args": [ { - "name": "System.Int32", - "default": "4" + "name": "System.Int32" } ], "description": "Specifies the number of echo requests to send. The default value is 4." @@ -35,9 +33,13 @@ ], "description": "Specifies the interval between pings, in seconds." }, + { + "name": "-Detailed", + "description": "When you use the Detailed parameter, this cmdlet returns a detailed information about the status of the TCP connection attempts." + }, { "name": "-DontFragment", - "description": "This parameter sets the Don't Fragment flag in the IP header. You can use this parameter with the BufferSize parameter to test the Path MTU size. For more information about Path MTU, see the Path MTU Discovery (https://wikipedia.org/wiki/Path_MTU_Discovery)article in wikipedia." + "description": "This parameter sets the Don't Fragment flag in the IP header. You can use this parameter with the BufferSize parameter to test the Path MTU size. For more information about Path MTU, see the [Path MTU Discovery](https://wikipedia.org/wiki/Path_MTU_Discovery) article in wikipedia." }, { "name": "-IPv4", @@ -56,8 +58,7 @@ ], "args": [ { - "name": "System.Int32", - "default": "128" + "name": "System.Int32" } ], "description": "Sets the maximum number of hops that an ICMP request message can be sent. The default value is controlled by the operating system. The default value for Windows 10 and higher is 128 hops." @@ -68,7 +69,7 @@ "-MtuSizeDetect" ], "isRequired": true, - "description": "This parameter is used to discover the Path MTU size. The cmdlet returns a PingReply#MTUSize object that contains the Path MTU size to the target. For more information about Path MTU, see the Path MTU Discovery (https://wikipedia.org/wiki/Path_MTU_Discovery)article in wikipedia." + "description": "This parameter is used to discover the Path MTU size. The cmdlet returns a PingReply#MTUSize object that contains the Path MTU size to the target. For more information about Path MTU, see the [Path MTU Discovery](https://wikipedia.org/wiki/Path_MTU_Discovery) article in wikipedia." }, { "name": "-Ping", @@ -76,7 +77,7 @@ }, { "name": "-Quiet", - "description": "The Quiet parameter returns a Boolean value. Using this parameter suppresses all errors.\n" + "description": "The Quiet parameter returns a Boolean value. Using this parameter suppresses all errors." }, { "name": [ @@ -94,11 +95,10 @@ "name": "-Source", "args": [ { - "name": "System.String", - "default": "Local computer" + "name": "System.String" } ], - "description": "Specifies the names of the computers where the ping originates. Enter a comma-separated list of computer names. The default is the local computer.\n" + "description": "Specifies the names of the computers where the ping originates. Enter a comma-separated list of computer names. The default is the local computer." }, { "name": [ @@ -121,17 +121,16 @@ } ], "isRequired": true, - "description": "Specifies the TCP port number on the target to be used in the TCP connection test. The cmdlet will attempt to make a TCP connection to the specified port on the target.\n" + "description": "Specifies the TCP port number on the target to be used in the TCP connection test." }, { "name": "-TimeoutSeconds", "args": [ { - "name": "System.Int32", - "default": "5 seconds" + "name": "System.Int32" } ], - "description": "Sets the timeout value for the test. The test fails if a response isn't received before the timeout expires. The default is five seconds.\n" + "description": "Sets the timeout value for the test. The test fails if a response isn't received before the timeout expires. The default is five seconds." }, { "name": "-Traceroute", diff --git a/command-signatures/json/autogenerated/powershell/test-filecatalog.json b/command-signatures/json/autogenerated/powershell/test-filecatalog.json new file mode 100644 index 00000000..af5e625f --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/test-filecatalog.json @@ -0,0 +1,237 @@ +{ + "name": "Test-FileCatalog", + "options": [ + { + "name": "-CatalogFilePath", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "A path to a catalog file (`.cat`) that contains the hashes to be used for validation." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Detailed", + "description": "Returns more information a more detailed `CatalogInformation` object that contains the files tested, their expected/actual hashes, and an Authenticode signature of the catalog file if it's signed." + }, + { + "name": "-FilesToSkip", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "An array of paths that should not be tested as part of the validation." + }, + { + "name": "-Path", + "args": [ + { + "name": "System.String[]" + } + ], + "description": "A folder or array of files that should be validated against the catalog file." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-CatalogFilePath", + "description": "A path to a catalog file (`.cat`) that contains the hashes to be used for validation." + }, + { + "name": "-Path", + "description": "A folder or array of files that should be validated against the catalog file." + } + ], + "description": "`Test-FileCatalog` validates whether the hashes contained in a catalog file (.cat) matches the hashes of the actual files in order to validate their authenticity. This cmdlet is only supported on Windows.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/test-json.json b/command-signatures/json/autogenerated/powershell/test-json.json index 885f831c..0de4f24a 100644 --- a/command-signatures/json/autogenerated/powershell/test-json.json +++ b/command-signatures/json/autogenerated/powershell/test-json.json @@ -9,7 +9,48 @@ } ], "isRequired": true, - "description": "Specifies the JSON string to test for validity. Enter a variable that contains the string, or type a command or expression that gets the string. You can also pipe a string to `Test-Json`.\n" + "description": "Specifies the JSON string to test for validity. Enter a variable that contains the string, or type a command or expression that gets the string. You can also pipe a string to `Test-Json`." + }, + { + "name": [ + "-LiteralPath", + "-PSPath", + "-LP" + ], + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies a path to a JSON file. The value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + }, + { + "name": "-Options", + "args": [ + { + "name": "System.String[]", + "suggestions": [ + { + "name": "AllowTrailingCommas" + }, + { + "name": "IgnoreComments" + } + ] + } + ], + "description": "By default, `Test-Json` doesn't support JSON containing comments or trailing commas. This parameter allows you to specify options to change the default behavior. The following options are available:" + }, + { + "name": "-Path", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the path to a JSON file. This cmdlet gets the item at the specified location. Wildcard characters are permitted but the pattern must resolve to a single file." }, { "name": "-Schema", @@ -18,7 +59,8 @@ "name": "System.String" } ], - "description": "Specifies a schema to validate the JSON input against. If passed, `Test-Json` validates that the JSON input conforms to the spec specified by the Schema parameter and return `$true` only if the input conforms to the provided schema.\n" + "isRequired": true, + "description": "Specifies a schema to validate the JSON input against. If passed, `Test-Json` validates that the JSON input conforms to the spec specified by the Schema parameter and return `$true` only if the input conforms to the provided schema." }, { "name": "-SchemaFile", @@ -27,7 +69,8 @@ "name": "System.String" } ], - "description": "Specifies a schema file used to validate the JSON input. When used, the `Test-Json` returns `$true` only if the JSON input conforms to the schema defined in the file specified by the SchemaFile parameter.\n" + "isRequired": true, + "description": "Specifies a schema file used to validate the JSON input. When used, the `Test-Json` returns `$true` only if the JSON input conforms to the schema defined in the file specified by the SchemaFile parameter." }, { "name": [ @@ -202,12 +245,10 @@ ], "args": [ { - "name": "-Json", - "description": "Specifies the JSON string to test for validity. Enter a variable that contains the string, or type a command or expression that gets the string. You can also pipe a string to `Test-Json`.\n" + "name": "-Json-Or-LiteralPath-Or-Path" }, { - "name": "-Schema", - "description": "Specifies a schema to validate the JSON input against. If passed, `Test-Json` validates that the JSON input conforms to the spec specified by the Schema parameter and return `$true` only if the input conforms to the provided schema.\n" + "name": "-Schema-Or-SchemaFile" } ], "description": "Tests whether a string is a valid JSON document", diff --git a/command-signatures/json/autogenerated/powershell/test-kdsrootkey.json b/command-signatures/json/autogenerated/powershell/test-kdsrootkey.json new file mode 100644 index 00000000..07ddf4d3 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/test-kdsrootkey.json @@ -0,0 +1,211 @@ +{ + "name": "Test-KdsRootKey", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-KeyId", + "args": [ + { + "name": "Guid" + } + ], + "isRequired": true, + "description": "Specifies the ID of the root key to test." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-KeyId", + "description": "Specifies the ID of the root key to test." + } + ], + "description": "Tests the root key configuration.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/test-path.json b/command-signatures/json/autogenerated/powershell/test-path.json index 87bcf413..91ce3c9f 100644 --- a/command-signatures/json/autogenerated/powershell/test-path.json +++ b/command-signatures/json/autogenerated/powershell/test-path.json @@ -7,7 +7,8 @@ { "name": "System.Management.Automation.PSCredential" } - ] + ], + "description": "> [!NOTE] > This parameter isn't supported by any providers installed with PowerShell. To impersonate another > user, or elevate your credentials when running this cmdlet, use > [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md)." }, { "name": "-Exclude", @@ -38,7 +39,7 @@ }, { "name": "-IsValid", - "description": "Indicates that this cmdlet tests the syntax of the path, regardless of whether the elements of the path exist. This cmdlet returns `$true` if the path syntax is valid and `$false` if it's not. If the path being tested includes a drive specification, the cmdlet returns false when the drive does not exist. PowerShell returns false because it doesn't know which drive provider to test.\n" + "description": "Indicates that this cmdlet tests the syntax of the path, regardless of whether the elements of the path exist. This cmdlet returns `$true` if the path syntax is valid and `$false` if it's not. If the path being tested includes a drive specification, the cmdlet returns false when the drive does not exist. PowerShell returns false because it doesn't know which drive provider to test." }, { "name": [ @@ -52,7 +53,7 @@ } ], "isRequired": true, - "description": "Specifies a path to be tested. Unlike Path , the value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcard characters. If the path includes characters that could be interpreted by PowerShell as escape sequences, you must enclose the path in single quote so that they won't be interpreted." + "description": "Specifies a path to be tested. Unlike Path, the value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcard characters. If the path includes characters that could be interpreted by PowerShell as escape sequences, you must enclose the path in single quote so that they won't be interpreted." }, { "name": "-NewerThan", @@ -61,7 +62,7 @@ "name": "System.Nullable`1[[System.DateTime]]" } ], - "description": "This is a dynamic parameter made available by the FileSystem provider.\n" + "description": "This is a dynamic parameter made available by the FileSystem provider." }, { "name": "-OlderThan", @@ -70,7 +71,7 @@ "name": "System.Nullable`1[[System.DateTime]]" } ], - "description": "This is a dynamic parameter made available by the FileSystem provider.\n" + "description": "This is a dynamic parameter made available by the FileSystem provider." }, { "name": "-Path", @@ -103,7 +104,7 @@ ] } ], - "description": "Specifies the type of the final element in the path. This cmdlet returns `$true` if the element is of the specified type and `$false` if it's not. The acceptable values for this parameter are:\n" + "description": "Specifies the type of the final element in the path. This cmdlet returns `$true` if the element is of the specified type and `$false` if it's not. The acceptable values for this parameter are:" }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/test-pssessionconfigurationfile.json b/command-signatures/json/autogenerated/powershell/test-pssessionconfigurationfile.json new file mode 100644 index 00000000..597f11e2 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/test-pssessionconfigurationfile.json @@ -0,0 +1,197 @@ +{ + "name": "Test-PSSessionConfigurationFile", + "options": [ + { + "name": "-Path", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the path and filename of a session configuration file (.pssc). If you omit the path, the default is the current folder. Wildcard characters are supported, but they must resolve to a single file. You can also pipe a session configuration file path to `Test-PSSessionConfigurationFile`." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Path", + "description": "Specifies the path and filename of a session configuration file (.pssc). If you omit the path, the default is the current folder. Wildcard characters are supported, but they must resolve to a single file. You can also pipe a session configuration file path to `Test-PSSessionConfigurationFile`." + } + ], + "description": "Verifies the keys and values in a session configuration file.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/test-wsman.json b/command-signatures/json/autogenerated/powershell/test-wsman.json new file mode 100644 index 00000000..38616892 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/test-wsman.json @@ -0,0 +1,282 @@ +{ + "name": "Test-WSMan", + "options": [ + { + "name": "-ApplicationName", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the application name in the connection. The default value of the ApplicationName parameter is WSMAN. The complete identifier for the remote endpoint is in the following format:" + }, + { + "name": [ + "-Authentication", + "-auth", + "-am" + ], + "args": [ + { + "name": "Microsoft.WSMan.Management.AuthenticationMechanism", + "suggestions": [ + { + "name": "Basic" + }, + { + "name": "ClientCertificate" + }, + { + "name": "Credssp" + }, + { + "name": "Default" + }, + { + "name": "Digest" + }, + { + "name": "Kerberos" + }, + { + "name": "Negotiate" + }, + { + "name": "None" + } + ] + } + ], + "description": "Specifies the authentication mechanism to be used at the server. The acceptable values for this parameter are:" + }, + { + "name": "-CertificateThumbprint", + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the digital public key certificate (X509) of a user account that has permission to perform this action. Enter the certificate thumbprint of the certificate." + }, + { + "name": [ + "-ComputerName", + "-cn" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Specifies the computer against which to run the management operation. The value can be a fully qualified domain name, a NetBIOS name, or an IP address. Use the local computer name, use localhost, or use a dot (`.`) to specify the local computer. The local computer is the default. When the remote computer is in a different domain from the user, you must use a fully qualified domain name must be used. You can pipe a value for this parameter to the cmdlet." + }, + { + "name": [ + "-Credential", + "-cred", + "-c" + ], + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a user account that has permission to perform this action. The default is the current user. Type a user name, such as User01, Domain01\\User01, or User@Domain.com. Or, enter a PSCredential object, such as one returned by the `Get-Credential` cmdlet. When you type a user name, this cmdlet prompts you for a password." + }, + { + "name": "-Port", + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Specifies the port to use when the client connects to the WinRM service. When the transport is HTTP, the default port is 80. When the transport is HTTPS, the default port is 443." + }, + { + "name": "-UseSSL", + "description": "Specifies that the Secure Sockets Layer (SSL) protocol is used to establish a connection to the remote computer. By default, SSL is not used." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-ComputerName", + "description": "Specifies the computer against which to run the management operation. The value can be a fully qualified domain name, a NetBIOS name, or an IP address. Use the local computer name, use localhost, or use a dot (`.`) to specify the local computer. The local computer is the default. When the remote computer is in a different domain from the user, you must use a fully qualified domain name must be used. You can pipe a value for this parameter to the cmdlet." + } + ], + "description": "Tests whether the WinRM service is running on a local or remote computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/trace-command.json b/command-signatures/json/autogenerated/powershell/trace-command.json index 9d5076ef..4fe2f1b9 100644 --- a/command-signatures/json/autogenerated/powershell/trace-command.json +++ b/command-signatures/json/autogenerated/powershell/trace-command.json @@ -11,7 +11,7 @@ "name": "System.Object[]" } ], - "description": "Specifies the parameters and parameter values for the command being traced. The alias for ArgumentList is Args . This feature is useful for debugging dynamic parameters.\n" + "description": "Specifies the parameters and parameter values for the command being traced. The alias for ArgumentList is Args. This feature is useful for debugging dynamic parameters." }, { "name": "-Command", @@ -21,7 +21,7 @@ } ], "isRequired": true, - "description": "Specifies a command that's being processed during the trace.\n" + "description": "Specifies a command that's being processed during the trace." }, { "name": "-Debugger", @@ -70,16 +70,16 @@ "name": "System.Diagnostics.TraceOptions", "suggestions": [ { - "name": "None" + "name": "Callstack" }, { - "name": "LogicalOperationStack" + "name": "DateTime" }, { - "name": "DateTime" + "name": "LogicalOperationStack" }, { - "name": "Timestamp" + "name": "None" }, { "name": "ProcessId" @@ -88,12 +88,12 @@ "name": "ThreadId" }, { - "name": "Callstack" + "name": "Timestamp" } ] } ], - "description": "Specifies optional data to the prefix of each trace message in the output. The acceptable values for this parameter are:\n" + "description": "Specifies optional data to the prefix of each trace message in the output. The acceptable values for this parameter are:" }, { "name": "-Name", @@ -112,25 +112,28 @@ "name": "System.Management.Automation.PSTraceSourceOptions", "suggestions": [ { - "name": "None" + "name": "All" + }, + { + "name": "Assert" }, { "name": "Constructor" }, { - "name": "Dispose" + "name": "Data" }, { - "name": "Finalizer" + "name": "Delegates" }, { - "name": "Method" + "name": "Dispose" }, { - "name": "Property" + "name": "Error" }, { - "name": "Delegates" + "name": "Errors" }, { "name": "Events" @@ -139,42 +142,39 @@ "name": "Exception" }, { - "name": "Lock" - }, - { - "name": "Error" + "name": "ExecutionFlow" }, { - "name": "Errors" + "name": "Finalizer" }, { - "name": "Warning" + "name": "Lock" }, { - "name": "Verbose" + "name": "Method" }, { - "name": "WriteLine" + "name": "None" }, { - "name": "Data" + "name": "Property" }, { "name": "Scope" }, { - "name": "ExecutionFlow" + "name": "Verbose" }, { - "name": "Assert" + "name": "Warning" }, { - "name": "All" + "name": "WriteLine" } ] } ], - "description": "Determines the type of events that are traced. The acceptable values for this parameter are:\n" + "description": "Determines the type of events that are traced. The acceptable values for this parameter are:" }, { "name": "-PSHost", @@ -361,28 +361,31 @@ }, { "name": "-Option", - "description": "Determines the type of events that are traced. The acceptable values for this parameter are:\n", + "description": "Determines the type of events that are traced. The acceptable values for this parameter are:", "suggestions": [ { - "name": "None" + "name": "All" + }, + { + "name": "Assert" }, { "name": "Constructor" }, { - "name": "Dispose" + "name": "Data" }, { - "name": "Finalizer" + "name": "Delegates" }, { - "name": "Method" + "name": "Dispose" }, { - "name": "Property" + "name": "Error" }, { - "name": "Delegates" + "name": "Errors" }, { "name": "Events" @@ -391,37 +394,34 @@ "name": "Exception" }, { - "name": "Lock" - }, - { - "name": "Error" + "name": "ExecutionFlow" }, { - "name": "Errors" + "name": "Finalizer" }, { - "name": "Warning" + "name": "Lock" }, { - "name": "Verbose" + "name": "Method" }, { - "name": "WriteLine" + "name": "None" }, { - "name": "Data" + "name": "Property" }, { "name": "Scope" }, { - "name": "ExecutionFlow" + "name": "Verbose" }, { - "name": "Assert" + "name": "Warning" }, { - "name": "All" + "name": "WriteLine" } ] } diff --git a/command-signatures/json/autogenerated/powershell/unblock-file.json b/command-signatures/json/autogenerated/powershell/unblock-file.json index c811e42e..80ac085d 100644 --- a/command-signatures/json/autogenerated/powershell/unblock-file.json +++ b/command-signatures/json/autogenerated/powershell/unblock-file.json @@ -1,6 +1,13 @@ { "name": "Unblock-File", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": [ "-LiteralPath", @@ -13,7 +20,7 @@ } ], "isRequired": true, - "description": "Specifies the files to unblock. Unlike Path , the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks (`'`). Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + "description": "Specifies the files to unblock. Unlike Path, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks (`'`). Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Path", @@ -25,13 +32,6 @@ "isRequired": true, "description": "Specifies the files to unblock. Wildcard characters are supported." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/unblock-tpm.json b/command-signatures/json/autogenerated/powershell/unblock-tpm.json new file mode 100644 index 00000000..dec1205e --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/unblock-tpm.json @@ -0,0 +1,209 @@ +{ + "name": "Unblock-Tpm", + "options": [ + { + "name": "-File", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a file that contains the current owner authorization value for the TPM. You can use the TPM Management Console to create this file." + }, + { + "name": [ + "-OwnerAuthorization", + "-o" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the current owner authorization value for the TPM." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-OwnerAuthorization", + "description": "Specifies the current owner authorization value for the TPM." + } + ], + "description": "Resets a TPM lockout.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/undo-dtcdiagnostictransaction.json b/command-signatures/json/autogenerated/powershell/undo-dtcdiagnostictransaction.json new file mode 100644 index 00000000..7de6aa7b --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/undo-dtcdiagnostictransaction.json @@ -0,0 +1,195 @@ +{ + "name": "Undo-DtcDiagnosticTransaction", + "options": [ + { + "name": "-Transaction", + "args": [ + { + "name": "DtcDiagnosticTransaction" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Transaction" + } + ], + "description": "Undo-DtcDiagnosticTransaction [-Transaction] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/undo-transaction.json b/command-signatures/json/autogenerated/powershell/undo-transaction.json new file mode 100644 index 00000000..19964e9c --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/undo-transaction.json @@ -0,0 +1,194 @@ +{ + "name": "Undo-Transaction", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ] + }, + { + "name": [ + "-WhatIf", + "-wi" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Undo-Transaction [-WhatIf] [-Confirm] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/uninstall-language.json b/command-signatures/json/autogenerated/powershell/uninstall-language.json new file mode 100644 index 00000000..fa111bbe --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/uninstall-language.json @@ -0,0 +1,205 @@ +{ + "name": "Uninstall-Language", + "options": [ + { + "name": [ + "-Language", + "-LanguageId", + "-LanguageTag" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "The bcp47 tag of the language to install." + }, + { + "name": "-PassThru", + "description": "If specified, this parameter returns the bcp47 tag of the newly installed language upon successful installation." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Language", + "description": "The bcp47 tag of the language to install." + } + ], + "description": "Uninstalls a language from a device.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/uninstall-package.json b/command-signatures/json/autogenerated/powershell/uninstall-package.json index b05b7248..2365f367 100644 --- a/command-signatures/json/autogenerated/powershell/uninstall-package.json +++ b/command-signatures/json/autogenerated/powershell/uninstall-package.json @@ -136,7 +136,7 @@ ] } ], - "description": "Specifies the scope for which to uninstall the package. The acceptable values for this parameter are as follows:\n" + "description": "Specifies the scope for which to uninstall the package. The acceptable values for this parameter are as follows:" }, { "name": "-SkipDependencies", @@ -164,7 +164,7 @@ ] } ], - "description": "Specifies whether to search for packages with a module, a script, or both. The acceptable values for this parameter are as follows:\n" + "description": "Specifies whether to search for packages with a module, a script, or both. The acceptable values for this parameter are as follows:" }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/uninstall-provisioningpackage.json b/command-signatures/json/autogenerated/powershell/uninstall-provisioningpackage.json new file mode 100644 index 00000000..312c6c4d --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/uninstall-provisioningpackage.json @@ -0,0 +1,261 @@ +{ + "name": "Uninstall-ProvisioningPackage", + "options": [ + { + "name": [ + "-AllInstalledPackages", + "-All" + ], + "isRequired": true, + "description": "Removes all installed packages." + }, + { + "name": [ + "-ConnectedDevice", + "-Device" + ], + "description": "If enabled, specifies that the device type is mobile." + }, + { + "name": [ + "-LogsDirectoryPath", + "-Logs" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the logs directory path." + }, + { + "name": [ + "-PackageId", + "-Id" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the ID of a package." + }, + { + "name": [ + "-PackagePath", + "-Path" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the package path." + }, + { + "name": "-RuntimeMetadata", + "args": [ + { + "name": "RuntimeProvPackageMetadata" + } + ], + "isRequired": true, + "description": "Specifies a runtime provisioning package metadata object." + }, + { + "name": [ + "-WprpFile", + "-Wprp" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location of the WPR profile file." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-PackageId-Or-RuntimeMetadata" + } + ], + "description": "Uninstalls .PPKG package from the local machine.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/uninstall-psresource.json b/command-signatures/json/autogenerated/powershell/uninstall-psresource.json index 9a6793d4..db75b926 100644 --- a/command-signatures/json/autogenerated/powershell/uninstall-psresource.json +++ b/command-signatures/json/autogenerated/powershell/uninstall-psresource.json @@ -1,6 +1,13 @@ { "name": "Uninstall-PSResource", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-InputObject", "args": [ @@ -32,10 +39,10 @@ "name": "Microsoft.PowerShell.PSResourceGet.UtilClasses.ScopeType", "suggestions": [ { - "name": "CurrentUser" + "name": "AllUsers" }, { - "name": "AllUsers" + "name": "CurrentUser" } ] } @@ -53,14 +60,7 @@ "name": "System.String" } ], - "description": "Specifies the version of the resource to be removed. The value can be an exact version or a version range using the NuGet versioning syntax.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the version of the resource to be removed. The value can be an exact version or a version range using the NuGet versioning syntax." }, { "name": [ @@ -245,7 +245,7 @@ "name": "-InputObject-Or-Name" } ], - "description": "Uninstalls a resource that was installed using PowerShellGet .", + "description": "Uninstalls a resource that was installed using PowerShellGet.", "parserDirectives": { "flagsArePosixNoncompliant": true, "flagsMatchUniquePrefix": true, diff --git a/command-signatures/json/autogenerated/powershell/uninstall-trustedprovisioningcertificate.json b/command-signatures/json/autogenerated/powershell/uninstall-trustedprovisioningcertificate.json new file mode 100644 index 00000000..15bf6639 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/uninstall-trustedprovisioningcertificate.json @@ -0,0 +1,231 @@ +{ + "name": "Uninstall-TrustedProvisioningCertificate", + "options": [ + { + "name": [ + "-ConnectedDevice", + "-Device" + ], + "description": "If enabled, specifies that the device type is mobile." + }, + { + "name": [ + "-LogsDirectoryPath", + "-Logs" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the logs directory path." + }, + { + "name": [ + "-Thumbprint", + "-Id" + ], + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies a certificate thumbprint." + }, + { + "name": [ + "-WprpFile", + "-Wprp" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the location of the WPR profile file." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Thumbprint", + "description": "Specifies a certificate thumbprint." + } + ], + "description": "Removes a previously installed provisioning certificate.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/unprotect-cmsmessage.json b/command-signatures/json/autogenerated/powershell/unprotect-cmsmessage.json index dacb14c3..bbd8b039 100644 --- a/command-signatures/json/autogenerated/powershell/unprotect-cmsmessage.json +++ b/command-signatures/json/autogenerated/powershell/unprotect-cmsmessage.json @@ -23,7 +23,7 @@ }, { "name": "-IncludeContext", - "description": "" + "description": "Determines whether to include the decrypted content in its original context, rather than output the decrypted content only." }, { "name": "-LiteralPath", @@ -33,7 +33,7 @@ } ], "isRequired": true, - "description": "Specifies the path to encrypted content that you want to decrypt. Unlike Path , the value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." + "description": "Specifies the path to encrypted content that you want to decrypt. Unlike Path, the value of LiteralPath is used exactly as it's typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences." }, { "name": "-Path", @@ -52,7 +52,7 @@ "name": "System.Management.Automation.CmsMessageRecipient[]" } ], - "description": "Specifies one or more CMS message recipients, identified in any of the following formats:\n" + "description": "Specifies one or more CMS message recipients, identified in any of the following formats:" }, { "name": [ @@ -231,7 +231,7 @@ }, { "name": "-To", - "description": "Specifies one or more CMS message recipients, identified in any of the following formats:\n" + "description": "Specifies one or more CMS message recipients, identified in any of the following formats:" } ], "description": "Decrypts content that has been encrypted by using the Cryptographic Message Syntax format.", diff --git a/command-signatures/json/autogenerated/powershell/unregister-event.json b/command-signatures/json/autogenerated/powershell/unregister-event.json index fe8fa288..ab0c43c8 100644 --- a/command-signatures/json/autogenerated/powershell/unregister-event.json +++ b/command-signatures/json/autogenerated/powershell/unregister-event.json @@ -1,6 +1,13 @@ { "name": "Unregister-Event", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Force", "description": "Cancels all event subscriptions, including subscriptions that were hidden by using the SupportEvent parameter of `Register-ObjectEvent`, `Register-WmiEvent`, and `Register-EngineEvent`." @@ -13,7 +20,7 @@ } ], "isRequired": true, - "description": "Specifies a source identifier that this cmdlet cancels event subscriptions.\n" + "description": "Specifies a source identifier that this cmdlet cancels event subscriptions." }, { "name": "-SubscriptionId", @@ -23,14 +30,7 @@ } ], "isRequired": true, - "description": "Specifies a source identifier ID that this cmdlet cancels event subscriptions.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies a source identifier ID that this cmdlet cancels event subscriptions." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/unregister-packagesource.json b/command-signatures/json/autogenerated/powershell/unregister-packagesource.json index dd98c02f..a22b61ec 100644 --- a/command-signatures/json/autogenerated/powershell/unregister-packagesource.json +++ b/command-signatures/json/autogenerated/powershell/unregister-packagesource.json @@ -17,7 +17,7 @@ "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies a user account that has permission to access the computer and run commands. Type a user name, such as User01 , Domain01\\User01 , or enter a PSCredential object, generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted for a password.\n" + "description": "Specifies a user account that has permission to access the computer and run commands. Type a user name, such as User01 , Domain01\\User01 , or enter a PSCredential object, generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted for a password." }, { "name": "-Force", diff --git a/command-signatures/json/autogenerated/powershell/unregister-psresourcerepository.json b/command-signatures/json/autogenerated/powershell/unregister-psresourcerepository.json index 36c30441..726f54ef 100644 --- a/command-signatures/json/autogenerated/powershell/unregister-psresourcerepository.json +++ b/command-signatures/json/autogenerated/powershell/unregister-psresourcerepository.json @@ -1,6 +1,13 @@ { "name": "Unregister-PSResourceRepository", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Name", "args": [ @@ -15,13 +22,6 @@ "name": "-PassThru", "description": "When specified, outputs a PSRepositoryInfo object for each repository that's removed." }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." - }, { "name": [ "-WhatIf", diff --git a/command-signatures/json/autogenerated/powershell/unregister-pssessionconfiguration.json b/command-signatures/json/autogenerated/powershell/unregister-pssessionconfiguration.json new file mode 100644 index 00000000..d479e705 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/unregister-pssessionconfiguration.json @@ -0,0 +1,219 @@ +{ + "name": "Unregister-PSSessionConfiguration", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "Indicates that the cmdlet does not prompt you for confirmation, and restarts the WinRM service without prompting. Restarting the service makes the configuration change effective." + }, + { + "name": "-Name", + "args": [ + { + "name": "System.String" + } + ], + "isRequired": true, + "description": "Specifies the names of the session configurations to delete. Enter one session configuration name or a configuration name pattern. Wildcard characters are permitted. This parameter is required." + }, + { + "name": "-NoServiceRestart", + "description": "Indicates that this cmdlet does not restart the WinRM service, and suppresses the prompt to restart the service." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-Name", + "description": "Specifies the names of the session configurations to delete. Enter one session configuration name or a configuration name pattern. Wildcard characters are permitted. This parameter is required." + } + ], + "description": "Deletes registered session configurations from the computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/unregister-scheduledjob.json b/command-signatures/json/autogenerated/powershell/unregister-scheduledjob.json new file mode 100644 index 00000000..60da5924 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/unregister-scheduledjob.json @@ -0,0 +1,182 @@ +{ + "name": "Unregister-ScheduledJob", + "options": [ + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Unregister-ScheduledJob", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/unregister-windowsdeveloperlicense.json b/command-signatures/json/autogenerated/powershell/unregister-windowsdeveloperlicense.json new file mode 100644 index 00000000..ace78f15 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/unregister-windowsdeveloperlicense.json @@ -0,0 +1,200 @@ +{ + "name": "Unregister-WindowsDeveloperLicense", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Force", + "description": "Disables Developer Mode without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet is not run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Disables Developer Mode on the current computer.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/update-formatdata.json b/command-signatures/json/autogenerated/powershell/update-formatdata.json index bb5d20a3..187b58ba 100644 --- a/command-signatures/json/autogenerated/powershell/update-formatdata.json +++ b/command-signatures/json/autogenerated/powershell/update-formatdata.json @@ -12,7 +12,14 @@ "name": "System.String[]" } ], - "description": "Specifies formatting files that this cmdlet adds to the session. The files are loaded after PowerShell loads the built-in formatting files.\n" + "description": "Specifies formatting files that this cmdlet adds to the session. The files are loaded after PowerShell loads the built-in formatting files." + }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." }, { "name": "-PrependPath", @@ -21,14 +28,7 @@ "name": "System.String[]" } ], - "description": "Specifies formatting files that this cmdlet adds to the session. The files are loaded before PowerShell loads the built-in formatting files.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies formatting files that this cmdlet adds to the session. The files are loaded before PowerShell loads the built-in formatting files." }, { "name": [ @@ -211,7 +211,7 @@ "args": [ { "name": "-AppendPath", - "description": "Specifies formatting files that this cmdlet adds to the session. The files are loaded after PowerShell loads the built-in formatting files.\n" + "description": "Specifies formatting files that this cmdlet adds to the session. The files are loaded after PowerShell loads the built-in formatting files." } ], "description": "Updates the formatting data in the current session.", diff --git a/command-signatures/json/autogenerated/powershell/update-help.json b/command-signatures/json/autogenerated/powershell/update-help.json index e0b82841..10f7f887 100644 --- a/command-signatures/json/autogenerated/powershell/update-help.json +++ b/command-signatures/json/autogenerated/powershell/update-help.json @@ -1,19 +1,25 @@ { "name": "Update-Help", "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ { - "name": "System.Management.Automation.PSCredential", - "default": "Current user" + "name": "System.Management.Automation.PSCredential" } ], - "description": "Specifies credentials of a user who has permission to access the file system location specified by SourcePath . This parameter is valid only when the SourcePath or LiteralPath parameter is used in the command.\n" + "description": "Specifies credentials of a user who has permission to access the file system location specified by SourcePath. This parameter is valid only when the SourcePath or LiteralPath parameter is used in the command." }, { "name": "-Force", - "description": "Indicates that this cmdlet doesn't follow the once-per-day limitation, skips version checking, and downloads files that exceed the 1 GB limit.\n" + "description": "Indicates that this cmdlet doesn't follow the once-per-day limitation, skips version checking, and downloads files that exceed the 1 GB limit." }, { "name": "-FullyQualifiedModule", @@ -22,7 +28,7 @@ "name": "Microsoft.PowerShell.Commands.ModuleSpecification[]" } ], - "description": "The value can be a module name, a full module specification, or a path to a module file.\n" + "description": "The value can be a module name, a full module specification, or a path to a module file." }, { "name": [ @@ -35,7 +41,7 @@ "name": "System.String[]" } ], - "description": "Specifies the folder for updated help files instead of downloading them from the internet. Use this parameter or SourcePath if you've used the `Save-Help` cmdlet to download help files to a directory.\n" + "description": "Specifies the folder for updated help files instead of downloading them from the internet. Use this parameter or SourcePath if you've used the `Save-Help` cmdlet to download help files to a directory." }, { "name": [ @@ -47,7 +53,7 @@ "name": "System.String[]" } ], - "description": "Updates help for the specified modules. Enter one or more module names or name patterns in a comma-separated list, or specify a file that lists one module name on each line. Wildcard characters are permitted. You can pipeline modules from the `Get-Module` cmdlet to the `Update-Help` cmdlet.\n" + "description": "Updates help for the specified modules. Enter one or more module names or name patterns in a comma-separated list, or specify a file that lists one module name on each line. Wildcard characters are permitted. You can pipeline modules from the `Get-Module` cmdlet to the `Update-Help` cmdlet." }, { "name": "-Recurse", @@ -58,10 +64,17 @@ "args": [ { "name": "Microsoft.PowerShell.Commands.UpdateHelpScope", - "default": "CurrentUser" + "suggestions": [ + { + "name": "AllUsers" + }, + { + "name": "CurrentUser" + } + ] } ], - "description": "Specifies the system scope where help is updated. Updates at the AllUsers scope require administrative privileges on Windows systems. The `-Scope` parameter was introduced in PowerShell Core version 6.1. CurrentUser is the default scope for help files in PowerShell 6.1 and above. AllUsers can be specified to install or update help for all users. On Unix systems `sudo` privileges are required to update help for all users. For example: `sudo pwsh -c Update-Help`\n" + "description": "Specifies the system scope where help is updated. Updates at the AllUsers scope require administrative privileges on Windows systems. The `-Scope` parameter was introduced in PowerShell Core version 6.1." }, { "name": [ @@ -73,7 +86,7 @@ "name": "System.String[]" } ], - "description": "Specifies a file system folder where `Update-Help` gets updated help files, instead of downloading them from the internet. Enter the path of a folder. Don't specify a file name or file name extension. You can pipeline a folder, such as one from the `Get-Item` or `Get-ChildItem` cmdlets, to `Update-Help`.\n" + "description": "Specifies a file system folder where `Update-Help` gets updated help files, instead of downloading them from the internet. Enter the path of a folder. Don't specify a file name or file name extension. You can pipeline a folder, such as one from the `Get-Item` or `Get-ChildItem` cmdlets, to `Update-Help`." }, { "name": "-UICulture", @@ -82,18 +95,11 @@ "name": "System.Globalization.CultureInfo[]" } ], - "description": "Specifies UI culture values that `Update-Help` uses to get updated help files. Enter one or more language codes, such as es-ES , a variable containing culture objects, or a command that gets culture objects, such as a `Get-Culture` or `Get-UICulture` command. Wildcard characters aren't permitted and you can't submit a partial language code, such as de .\n" + "description": "Specifies UI culture values for which this cmdlet gets updated help files. Enter one or more language codes, such as `es-ES`, a variable that contains culture objects, or a command that gets culture objects, such as a `Get-Culture` or `Get-UICulture` command. Wildcard characters are not permitted." }, { "name": "-UseDefaultCredentials", - "description": "Indicates that `Update-Help` runs the command, including the internet download, using the credentials of the current user. By default, the command runs without explicit credentials.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Indicates that `Update-Help` runs the command, including the internet download, using the credentials of the current user. By default, the command runs without explicit credentials." }, { "name": [ @@ -276,15 +282,15 @@ "args": [ { "name": "-Module", - "description": "Updates help for the specified modules. Enter one or more module names or name patterns in a comma-separated list, or specify a file that lists one module name on each line. Wildcard characters are permitted. You can pipeline modules from the `Get-Module` cmdlet to the `Update-Help` cmdlet.\n" + "description": "Updates help for the specified modules. Enter one or more module names or name patterns in a comma-separated list, or specify a file that lists one module name on each line. Wildcard characters are permitted. You can pipeline modules from the `Get-Module` cmdlet to the `Update-Help` cmdlet." }, { "name": "-SourcePath", - "description": "Specifies a file system folder where `Update-Help` gets updated help files, instead of downloading them from the internet. Enter the path of a folder. Don't specify a file name or file name extension. You can pipeline a folder, such as one from the `Get-Item` or `Get-ChildItem` cmdlets, to `Update-Help`.\n" + "description": "Specifies a file system folder where `Update-Help` gets updated help files, instead of downloading them from the internet. Enter the path of a folder. Don't specify a file name or file name extension. You can pipeline a folder, such as one from the `Get-Item` or `Get-ChildItem` cmdlets, to `Update-Help`." }, { "name": "-UICulture", - "description": "Specifies UI culture values that `Update-Help` uses to get updated help files. Enter one or more language codes, such as es-ES , a variable containing culture objects, or a command that gets culture objects, such as a `Get-Culture` or `Get-UICulture` command. Wildcard characters aren't permitted and you can't submit a partial language code, such as de .\n" + "description": "Specifies UI culture values for which this cmdlet gets updated help files. Enter one or more language codes, such as `es-ES`, a variable that contains culture objects, or a command that gets culture objects, such as a `Get-Culture` or `Get-UICulture` command. Wildcard characters are not permitted." } ], "description": "Downloads and installs the newest help files on your computer.", diff --git a/command-signatures/json/autogenerated/powershell/update-lapsadschema.json b/command-signatures/json/autogenerated/powershell/update-lapsadschema.json new file mode 100644 index 00000000..7ac91cab --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/update-lapsadschema.json @@ -0,0 +1,205 @@ +{ + "name": "Update-LapsADSchema", + "options": [ + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, + { + "name": "-Credential", + "args": [ + { + "name": "System.Management.Automation.PSCredential" + } + ], + "description": "Specifies a set of credentials to use when extending the schema. If not specified, the current user's credentials are used." + }, + { + "name": [ + "-WhatIf", + "-wi" + ], + "description": "Shows what would happen if the cmdlet runs. The cmdlet isn't run." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Extends the Active Directory (AD) schema with the Windows Local Administrator Password Solution (LAPS) schema attributes.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/update-psmodulemanifest.json b/command-signatures/json/autogenerated/powershell/update-psmodulemanifest.json index 58508f4f..554a8e77 100644 --- a/command-signatures/json/autogenerated/powershell/update-psmodulemanifest.json +++ b/command-signatures/json/autogenerated/powershell/update-psmodulemanifest.json @@ -50,18 +50,10 @@ "name": "-CompatiblePSEditions", "args": [ { - "name": "System.String[]", - "suggestions": [ - { - "name": "Desktop" - }, - { - "name": "Core" - } - ] + "name": "System.String[]" } ], - "description": "Specifies the compatible PSEditions of the module. For information about PSEdition , see Modules with compatible PowerShell Editions (/powershell/scripting/gallery/concepts/module-psedition-support)." + "description": "Specifies the compatible PSEditions of the module. For information about PSEdition, see [Modules with compatible PowerShell Editions](/powershell/scripting/gallery/concepts/module-psedition-support)." }, { "name": "-Copyright", @@ -133,7 +125,7 @@ "name": "System.String[]" } ], - "description": "Specifies the formatting files (`.ps1xml`) that are processed when the module is imported.\n" + "description": "Specifies the formatting files (`.ps1xml`) that are processed when the module is imported." }, { "name": "-FunctionsToExport", @@ -160,7 +152,7 @@ "name": "System.Uri" } ], - "description": "Specifies the internet address of the module's HelpInfo XML file. Enter a Uniform Resource Identifier (URI) that begins with `http:` or `https:`.\n" + "description": "Specifies the internet address of the module's HelpInfo XML file. Enter a Uniform Resource Identifier (URI) that begins with `http:` or `https:`." }, { "name": "-IconUri", @@ -187,7 +179,7 @@ "name": "System.Object[]" } ], - "description": "Specifies an array of modules that are included in the module.\n" + "description": "Specifies an array of modules that are included in the module." }, { "name": "-ModuleVersion", @@ -205,7 +197,7 @@ "name": "System.Object[]" } ], - "description": "Specifies script modules (`.psm1`) and binary modules (`.dll`) that are imported into the module's session state. The files in the NestedModules key run in the order in which they're listed.\n" + "description": "Specifies script modules (`.psm1`) and binary modules (`.dll`) that are imported into the module's session state. The files in the NestedModules key run in the order in which they're listed." }, { "name": "-Path", @@ -224,7 +216,7 @@ "name": "System.String" } ], - "description": "Specifies the name of the PowerShell host program that the module requires. Enter the name of the host program, such as PowerShell ISE Host or ConsoleHost. Wildcards aren't permitted.\n" + "description": "Specifies the name of the PowerShell host program that the module requires. Enter the name of the host program, such as PowerShell ISE Host or ConsoleHost. Wildcards aren't permitted." }, { "name": "-PowerShellHostVersion", @@ -266,10 +258,30 @@ "name": "-ProcessorArchitecture", "args": [ { - "name": "System.Reflection.ProcessorArchitecture" + "name": "System.Reflection.ProcessorArchitecture", + "suggestions": [ + { + "name": "Amd64" + }, + { + "name": "Arm" + }, + { + "name": "IA64" + }, + { + "name": "MSIL" + }, + { + "name": "None" + }, + { + "name": "X86" + } + ] } ], - "description": "Specifies the processor architecture that the module requires.\n" + "description": "Specifies the processor architecture that the module requires." }, { "name": "-ProjectUri", @@ -296,7 +308,7 @@ "name": "System.String[]" } ], - "description": "Specifies the assembly (`.dll`) files required by the module. PowerShell loads the specified assemblies before updating types or formats, importing nested modules, or importing the module file specified in the RootModule key.\n" + "description": "Specifies the assembly (`.dll`) files required by the module. PowerShell loads the specified assemblies before updating types or formats, importing nested modules, or importing the module file specified in the RootModule key." }, { "name": "-RequiredModules", @@ -305,7 +317,7 @@ "name": "System.Object[]" } ], - "description": "Specifies modules that must be in the global session state. If the required modules aren't in the global session state, PowerShell imports them. If the required modules aren't available, the `Import-Module` command fails.\n" + "description": "Specifies modules that must be in the global session state. If the required modules aren't in the global session state, PowerShell imports them. If the required modules aren't available, the `Import-Module` command fails." }, { "name": "-RequireLicenseAcceptance", @@ -318,7 +330,7 @@ "name": "System.String" } ], - "description": "Specifies the primary or root file of the module. Enter the filename of a script (`.ps1`), a script module (`.psm1`), a module manifest (`.psd1`), an assembly (`.dll`), or a cmdlet definition XML file (`.cdxml`). When the module is imported, the members exported from the root module are imported into the caller's session state.\n" + "description": "Specifies the primary or root file of the module. Enter the filename of a script (`.ps1`), a script module (`.psm1`), a module manifest (`.psd1`), an assembly (`.dll`), or a cmdlet definition XML file (`.cdxml`). When the module is imported, the members exported from the root module are imported into the caller's session state." }, { "name": "-ScriptsToProcess", @@ -327,7 +339,7 @@ "name": "System.String[]" } ], - "description": "Specifies script (`.ps1`) files that run in the caller's session state when the module is imported. You can use these scripts to prepare an environment, just as you might use a login script.\n" + "description": "Specifies script (`.ps1`) files that run in the caller's session state when the module is imported. You can use these scripts to prepare an environment, just as you might use a login script." }, { "name": [ @@ -348,7 +360,7 @@ "name": "System.String[]" } ], - "description": "Specifies the type files (`.ps1xml`) that run when the module is imported.\n" + "description": "Specifies the type files (`.ps1xml`) that run when the module is imported." }, { "name": "-VariablesToExport", @@ -357,7 +369,7 @@ "name": "System.String[]" } ], - "description": "Specifies the variables that the module exports. Wildcards are permitted.\n" + "description": "Specifies the variables that the module exports. Wildcards are permitted." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/update-psresource.json b/command-signatures/json/autogenerated/powershell/update-psresource.json index 6cef4af9..e3b7efa3 100644 --- a/command-signatures/json/autogenerated/powershell/update-psresource.json +++ b/command-signatures/json/autogenerated/powershell/update-psresource.json @@ -9,6 +9,13 @@ "name": "-AuthenticodeCheck", "description": "Validates signed files and catalog files on Windows." }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-Credential", "args": [ @@ -26,8 +33,7 @@ "name": "-Name", "args": [ { - "name": "System.String[]", - "default": "\"*\"" + "name": "System.String[]" } ], "description": "Specifies the name of one or more resources to update. Wildcards are supported but NuGet only accepts the `*` character. NuGet doesn't support wildcard searches of local (file-based) repositories." @@ -51,7 +57,7 @@ "name": "System.String[]" } ], - "description": "Specifies one or more repository names to search. If not specified, search includes all registered repositories, in priority order (highest first), until a repository is found that contains the package. Repositories are sorted by priority then by name. Lower Priority values have a higher precedence.\n" + "description": "Specifies one or more repository names to search. If not specified, search includes all registered repositories, in priority order (highest first), until a repository is found that contains the package. Repositories are sorted by priority then by name. Lower Priority values have a higher precedence." }, { "name": "-Scope", @@ -60,15 +66,15 @@ "name": "Microsoft.PowerShell.PSResourceGet.UtilClasses.ScopeType", "suggestions": [ { - "name": "CurrentUser" + "name": "AllUsers" }, { - "name": "AllUsers" + "name": "CurrentUser" } ] } ], - "description": "Specifies the installation scope. Accepted values are:\n" + "description": "Specifies the installation scope. Accepted values are:" }, { "name": "-SkipDependencyCheck", @@ -94,14 +100,7 @@ "name": "System.String" } ], - "description": "Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/update-psscriptfileinfo.json b/command-signatures/json/autogenerated/powershell/update-psscriptfileinfo.json index bdec5cda..0e896491 100644 --- a/command-signatures/json/autogenerated/powershell/update-psscriptfileinfo.json +++ b/command-signatures/json/autogenerated/powershell/update-psscriptfileinfo.json @@ -130,7 +130,7 @@ "name": "System.Collections.Hashtable[]" } ], - "description": "The parameter takes an array of module specification hashtables. A module specification is a hashtable that has the following keys.\n" + "description": "The parameter takes an array of module specification hashtables. A module specification is a hashtable that has the following keys." }, { "name": "-RequiredScripts", @@ -151,7 +151,7 @@ "name": "System.String[]" } ], - "description": "The tags associated with the script. Tag values are strings that shouldn't contain spaces. For more information, see Tag details (/powershell/scripting/gallery/concepts/package-manifest-affecting-ui#tag-details)." + "description": "The tags associated with the script. Tag values are strings that shouldn't contain spaces. For more information, see [Tag details](/powershell/scripting/gallery/concepts/package-manifest-affecting-ui#tag-details)." }, { "name": "-Version", diff --git a/command-signatures/json/autogenerated/powershell/update-typedata.json b/command-signatures/json/autogenerated/powershell/update-typedata.json index 5ca96457..3c7eaccd 100644 --- a/command-signatures/json/autogenerated/powershell/update-typedata.json +++ b/command-signatures/json/autogenerated/powershell/update-typedata.json @@ -14,6 +14,13 @@ ], "description": "Specifies the path to optional `.ps1xml` files. The specified files are loaded in the order that they are listed after the built-in files are loaded. You can also pipe an AppendPath value to `Update-TypeData`." }, + { + "name": [ + "-Confirm", + "-cf" + ], + "description": "Prompts you for confirmation before running the cmdlet." + }, { "name": "-DefaultDisplayProperty", "args": [ @@ -21,7 +28,7 @@ "name": "System.String" } ], - "description": "Specifies the property of the type that is displayed by the `Format-Wide` cmdlet when no other properties are specified.\n" + "description": "Specifies the property of the type that is displayed by the `Format-Wide` cmdlet when no other properties are specified." }, { "name": "-DefaultDisplayPropertySet", @@ -30,7 +37,7 @@ "name": "System.String[]" } ], - "description": "Specifies one or more properties of the type. These properties are displayed by the `Format-List`, `Format-Table`, and `Format-Custom` cmdlets when no other properties are specified.\n" + "description": "Specifies one or more properties of the type. These properties are displayed by the `Format-List`, `Format-Table`, and `Format-Custom` cmdlets when no other properties are specified." }, { "name": "-DefaultKeyPropertySet", @@ -39,11 +46,11 @@ "name": "System.String[]" } ], - "description": "Specifies one or more properties of the type. These properties are used by the `Group-Object` and `Sort-Object` cmdlets when no other properties are specified.\n" + "description": "Specifies one or more properties of the type. These properties are used by the `Group-Object` and `Sort-Object` cmdlets when no other properties are specified." }, { "name": "-Force", - "description": "Indicates that the cmdlet uses the specified type data, even if type data has already been specified for that type.\n" + "description": "Indicates that the cmdlet uses the specified type data, even if type data has already been specified for that type." }, { "name": "-InheritPropertySerializationSet", @@ -52,7 +59,7 @@ "name": "System.Nullable`1[System.Boolean]" } ], - "description": "Indicates whether the set of properties that are serialized is inherited. The default value is `$Null`. The acceptable values for this parameter are:\n" + "description": "Indicates whether the set of properties that are serialized is inherited. The default value is `$null`. The acceptable values for this parameter are:" }, { "name": "-MemberName", @@ -61,7 +68,7 @@ "name": "System.String" } ], - "description": "Specifies the name of a property or method.\n" + "description": "Specifies the name of a property or method." }, { "name": "-MemberType", @@ -70,27 +77,60 @@ "name": "System.Management.Automation.PSMemberTypes", "suggestions": [ { - "name": "NoteProperty" + "name": "AliasProperty" }, { - "name": "AliasProperty" + "name": "All" }, { - "name": "ScriptProperty" + "name": "CodeMethod" }, { "name": "CodeProperty" }, + { + "name": "Dynamic" + }, + { + "name": "Event" + }, + { + "name": "InferredProperty" + }, + { + "name": "MemberSet" + }, + { + "name": "Method" + }, + { + "name": "Methods" + }, + { + "name": "NoteProperty" + }, + { + "name": "ParameterizedProperty" + }, + { + "name": "Properties" + }, + { + "name": "Property" + }, + { + "name": "PropertySet" + }, { "name": "ScriptMethod" }, { - "name": "CodeMethod" + "name": "ScriptProperty" } ] } ], - "description": "Specifies the type of the member to add or change.\n" + "description": "Specifies the type of the member to add or change." }, { "name": "-PrependPath", @@ -108,7 +148,7 @@ "name": "System.String[]" } ], - "description": "Specifies the names of properties that are serialized. Use this parameter when the value of the SerializationMethod parameter is SpecificProperties ." + "description": "Specifies the names of properties that are serialized. Use this parameter when the value of the SerializationMethod parameter is SpecificProperties." }, { "name": "-SecondValue", @@ -117,17 +157,16 @@ "name": "System.Object" } ], - "description": "Specifies additional values for AliasProperty , ScriptProperty , CodeProperty , or CodeMethod members.\n" + "description": "Specifies additional values for AliasProperty, ScriptProperty, CodeProperty, or CodeMethod members." }, { "name": "-SerializationDepth", "args": [ { - "name": "System.Int32", - "default": "1" + "name": "System.Int32" } ], - "description": "Specifies how many levels of type objects are serialized as strings. The default value `1` serializes the object and its properties. A value of `0` serializes the object, but not its properties. A value of `2` serializes the object, its properties, and any objects in property values.\n" + "description": "Specifies how many levels of type objects are serialized as strings. The default value `1` serializes the object and its properties. A value of `0` serializes the object, but not its properties. A value of `2` serializes the object, its properties, and any objects in property values." }, { "name": "-SerializationMethod", @@ -136,7 +175,7 @@ "name": "System.String" } ], - "description": "Specifies a serialization method for the type. A serialization method determines which properties of the type are serialized and the technique that is used to serialize them. The acceptable values for this parameter are:\n" + "description": "Specifies a serialization method for the type. A serialization method determines which properties of the type are serialized and the technique that is used to serialize them. The acceptable values for this parameter are:" }, { "name": "-StringSerializationSource", @@ -154,7 +193,7 @@ "name": "System.Type" } ], - "description": "Specifies the type to which object of this type are converted when they are deserialized.\n" + "description": "Specifies the type to which object of this type are converted when they are deserialized." }, { "name": "-TypeAdapter", @@ -163,7 +202,7 @@ "name": "System.Type" } ], - "description": "Specifies the type of a type adapter, such as Microsoft.PowerShell.Cim.CimInstanceAdapter . A type adapter enables PowerShell to get the members of a type.\n" + "description": "Specifies the type of a type adapter, such as Microsoft.PowerShell.Cim.CimInstanceAdapter. A type adapter enables PowerShell to get the members of a type." }, { "name": "-TypeConverter", @@ -172,7 +211,7 @@ "name": "System.Type" } ], - "description": "Specifies a type converter to convert values between different types. If a type converter is defined for a type, an instance of the type converter is used for the conversion.\n" + "description": "Specifies a type converter to convert values between different types. If a type converter is defined for a type, an instance of the type converter is used for the conversion." }, { "name": "-TypeData", @@ -182,7 +221,7 @@ } ], "isRequired": true, - "description": "Specifies an array of type data that this cmdlet adds to the session. Enter a variable that contains a TypeData object or a command that gets a TypeData object, such as a `Get-TypeData` command. You can also pipe a TypeData object to `Update-TypeData`.\n" + "description": "Specifies an array of type data that this cmdlet adds to the session. Enter a variable that contains a TypeData object or a command that gets a TypeData object, such as a `Get-TypeData` command. You can also pipe a TypeData object to `Update-TypeData`." }, { "name": "-TypeName", @@ -192,7 +231,7 @@ } ], "isRequired": true, - "description": "Specifies the name of the type to extend.\n" + "description": "Specifies the name of the type to extend." }, { "name": "-Value", @@ -201,14 +240,7 @@ "name": "System.Object" } ], - "description": "Specifies the value of the property or method.\n" - }, - { - "name": [ - "-Confirm", - "-cf" - ], - "description": "Prompts you for confirmation before running the cmdlet." + "description": "Specifies the value of the property or method." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/update-wimbootentry.json b/command-signatures/json/autogenerated/powershell/update-wimbootentry.json new file mode 100644 index 00000000..453009e5 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/update-wimbootentry.json @@ -0,0 +1,259 @@ +{ + "name": "Update-WIMBootEntry", + "options": [ + { + "name": "-DataSourceID", + "args": [ + { + "name": "Int64" + } + ], + "isRequired": true, + "description": "Specifies the data source ID. Use Get-WIMBootEntry to display the data source ID." + }, + { + "name": "-ImagePath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the renamed or moved image file." + }, + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the path to the disk volume of the WIMBoot configuration." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Updates the Windows image file boot (WIMBoot) configuration entry, associated with either the specified data source ID, the renamed image file path or the moved image file path.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/use-transaction.json b/command-signatures/json/autogenerated/powershell/use-transaction.json new file mode 100644 index 00000000..aa93b7ba --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/use-transaction.json @@ -0,0 +1,201 @@ +{ + "name": "Use-Transaction", + "options": [ + { + "name": "-TransactedScript", + "args": [ + { + "name": "scriptblock" + } + ], + "isRequired": true + }, + { + "name": [ + "-UseTransaction", + "-usetx" + ] + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-TransactedScript" + } + ], + "description": "Use-Transaction [-TransactedScript] [-UseTransaction] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/use-windowsunattend.json b/command-signatures/json/autogenerated/powershell/use-windowsunattend.json new file mode 100644 index 00000000..08150d77 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/use-windowsunattend.json @@ -0,0 +1,276 @@ +{ + "name": "Use-WindowsUnattend", + "options": [ + { + "name": [ + "-LogLevel", + "-LL" + ], + "args": [ + { + "name": "LogLevel", + "suggestions": [ + { + "name": "Debug" + }, + { + "name": "Errors" + }, + { + "name": "Warnings" + }, + { + "name": "WarningsInfo" + } + ] + } + ], + "description": "Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows: - 1 = Errors only - 2 = Errors and warnings - 3 = Errors, warnings, and information - 4 = All of the information listed previously, plus debug output" + }, + { + "name": [ + "-LogPath", + "-LP" + ], + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the full path and file name to log to. If not set, the default is `%WINDIR%\\Logs\\Dism\\dism.log`. In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log." + }, + { + "name": "-NoRestart", + "description": "Suppresses reboot. If a reboot is not required, this command does nothing. This option will keep the application from prompting for a restart or keep it from restarting automatically." + }, + { + "name": "-Online", + "isRequired": true, + "description": "Specifies that the action is to be taken on the operating system that is currently running on the local computer." + }, + { + "name": "-Path", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified." + }, + { + "name": "-ScratchDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the `\\Windows\\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory." + }, + { + "name": "-SystemDrive", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment." + }, + { + "name": "-UnattendPath", + "args": [ + { + "name": "String" + } + ], + "isRequired": true, + "description": "Specifies the location of the unattend.xml answer file to apply to the image." + }, + { + "name": "-WindowsDirectory", + "args": [ + { + "name": "String" + } + ], + "description": "Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory." + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [], + "description": "Applies an unattended answer file to a Windows image.", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/wait-event.json b/command-signatures/json/autogenerated/powershell/wait-event.json index 662eaa30..50cf5371 100644 --- a/command-signatures/json/autogenerated/powershell/wait-event.json +++ b/command-signatures/json/autogenerated/powershell/wait-event.json @@ -17,11 +17,10 @@ ], "args": [ { - "name": "System.Int32", - "default": "-1" + "name": "System.Int32" } ], - "description": "Specifies the maximum time, in seconds, that `Wait-Event` waits for the event to occur. The default, -1, waits indefinitely. The timing starts when you submit the `Wait-Event` command.\n" + "description": "Specifies the maximum time, in seconds, that `Wait-Event` waits for the event to occur. The default, -1, waits indefinitely. The timing starts when you submit the `Wait-Event` command." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/wait-job.json b/command-signatures/json/autogenerated/powershell/wait-job.json index 30bee115..3c6b66f3 100644 --- a/command-signatures/json/autogenerated/powershell/wait-job.json +++ b/command-signatures/json/autogenerated/powershell/wait-job.json @@ -13,11 +13,11 @@ } ], "isRequired": true, - "description": "Specifies a hash table of conditions. This cmdlet waits for jobs that satisfy all of the conditions in the hash table. Enter a hash table where the keys are job properties and the values are job property values.\n" + "description": "Specifies a hash table of conditions. This cmdlet waits for jobs that satisfy all of the conditions in the hash table. Enter a hash table where the keys are job properties and the values are job property values." }, { "name": "-Force", - "description": "Indicates that this cmdlet continues to wait for jobs in the Suspended or Disconnected state. By default, `Wait-Job` returns, or ends the wait, when jobs are in one of the following states:\n" + "description": "Indicates that this cmdlet continues to wait for jobs in the Suspended or Disconnected state. By default, `Wait-Job` returns, or ends the wait, when jobs are in one of the following states:" }, { "name": "-Id", @@ -27,7 +27,7 @@ } ], "isRequired": true, - "description": "Specifies an array of IDs of jobs for which this cmdlet waits.\n" + "description": "Specifies an array of IDs of jobs for which this cmdlet waits." }, { "name": "-InstanceId", @@ -37,7 +37,7 @@ } ], "isRequired": true, - "description": "Specifies an array of instance IDs of jobs for which this cmdlet waits. The default is all jobs.\n" + "description": "Specifies an array of instance IDs of jobs for which this cmdlet waits. The default is all jobs." }, { "name": "-Job", @@ -66,43 +66,43 @@ "name": "System.Management.Automation.JobState", "suggestions": [ { - "name": "NotStarted" + "name": "AtBreakpoint" }, { - "name": "Running" + "name": "Blocked" }, { "name": "Completed" }, { - "name": "Failed" + "name": "Disconnected" }, { - "name": "Stopped" + "name": "Failed" }, { - "name": "Blocked" + "name": "NotStarted" }, { - "name": "Suspended" + "name": "Running" }, { - "name": "Disconnected" + "name": "Stopped" }, { - "name": "Suspending" + "name": "Stopping" }, { - "name": "Stopping" + "name": "Suspended" }, { - "name": "AtBreakpoint" + "name": "Suspending" } ] } ], "isRequired": true, - "description": "Specifies a job state. This cmdlet waits only for jobs in the specified state. The acceptable values for this parameter are:\n" + "description": "Specifies a job state. This cmdlet waits only for jobs in the specified state. The acceptable values for this parameter are:" }, { "name": [ @@ -114,7 +114,7 @@ "name": "System.Int32" } ], - "description": "Specifies the maximum wait time for each job, in seconds. The default value, -1, indicates that the cmdlet waits until the job finishes. The timing starts when you submit the `Wait-Job` command, not the `Start-Job` command.\n" + "description": "Specifies the maximum wait time for each job, in seconds. The default value, -1, indicates that the cmdlet waits until the job finishes. The timing starts when you submit the `Wait-Job` command, not the `Start-Job` command." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/wait-process.json b/command-signatures/json/autogenerated/powershell/wait-process.json index 5a2c9480..005c5d6e 100644 --- a/command-signatures/json/autogenerated/powershell/wait-process.json +++ b/command-signatures/json/autogenerated/powershell/wait-process.json @@ -1,6 +1,10 @@ { "name": "Wait-Process", "options": [ + { + "name": "-Any", + "description": "When multiple processes are passed into `Wait-Process`, the cmdlet waits for all processes to exit before returning. With this parameter, the cmdlet returns when any of the processes exits. The remaining processes continue to run." + }, { "name": [ "-Id", @@ -39,6 +43,10 @@ "isRequired": true, "description": "Specifies the process names of the processes. To specify multiple names, use commas to separate the names. Wildcard characters are not supported." }, + { + "name": "-PassThru", + "description": "By default, this cmdlet doesn't output anything. With this parameter, the cmdlet returns objects representing the processes that were waited on." + }, { "name": [ "-Timeout", diff --git a/command-signatures/json/autogenerated/powershell/where-object.json b/command-signatures/json/autogenerated/powershell/where-object.json index 5aac4e04..f2a5e10c 100644 --- a/command-signatures/json/autogenerated/powershell/where-object.json +++ b/command-signatures/json/autogenerated/powershell/where-object.json @@ -4,72 +4,72 @@ { "name": "-CContains", "isRequired": true, - "description": "Indicates that this cmdlet gets objects from a collection if the property value of the object is an exact match for the specified value. This operation is case-sensitive.\n" + "description": "Indicates that this cmdlet gets objects from a collection if the property value of the object is an exact match for the specified value. This operation is case-sensitive." }, { "name": "-CEQ", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value is the same as the specified value. This operation is case-sensitive.\n" + "description": "Indicates that this cmdlet gets objects if the property value is the same as the specified value. This operation is case-sensitive." }, { "name": "-CGE", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value is greater than or equal to the specified value. This operation is case-sensitive.\n" + "description": "Indicates that this cmdlet gets objects if the property value is greater than or equal to the specified value. This operation is case-sensitive." }, { "name": "-CGT", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value is greater than the specified value. This operation is case-sensitive.\n" + "description": "Indicates that this cmdlet gets objects if the property value is greater than the specified value. This operation is case-sensitive." }, { "name": "-CIn", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value includes the specified value. This operation is case-sensitive.\n" + "description": "Indicates that this cmdlet gets objects if the property value includes the specified value. This operation is case-sensitive." }, { "name": "-CLE", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value is less-than or equal to the specified value. This operation is case-sensitive.\n" + "description": "Indicates that this cmdlet gets objects if the property value is less-than or equal to the specified value. This operation is case-sensitive." }, { "name": "-CLike", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value matches a value that includes wildcard characters (`*`). This operation is case-sensitive.\n" + "description": "Indicates that this cmdlet gets objects if the property value matches a value that includes wildcard characters (`*`). This operation is case-sensitive." }, { "name": "-CLT", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value is less-than the specified value. This operation is case-sensitive.\n" + "description": "Indicates that this cmdlet gets objects if the property value is less-than the specified value. This operation is case-sensitive." }, { "name": "-CMatch", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value matches the specified regular expression. This operation is case-sensitive. When the input is a single object, the matched value is saved in the `$Matches` automatic variable.\n" + "description": "Indicates that this cmdlet gets objects if the property value matches the specified regular expression. This operation is case-sensitive. When the input is a single object, the matched value is saved in the `$Matches` automatic variable." }, { "name": "-CNE", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value is different than the specified value. This operation is case-sensitive.\n" + "description": "Indicates that this cmdlet gets objects if the property value is different than the specified value. This operation is case-sensitive." }, { "name": "-CNotContains", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value of the object isn't an exact match for the specified value. This operation is case-sensitive.\n" + "description": "Indicates that this cmdlet gets objects if the property value of the object isn't an exact match for the specified value. This operation is case-sensitive." }, { "name": "-CNotIn", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value isn't an exact match for the specified value. This operation is case-sensitive.\n" + "description": "Indicates that this cmdlet gets objects if the property value isn't an exact match for the specified value. This operation is case-sensitive." }, { "name": "-CNotLike", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value doesn't match a value that includes wildcard characters. This operation is case-sensitive.\n" + "description": "Indicates that this cmdlet gets objects if the property value doesn't match a value that includes wildcard characters. This operation is case-sensitive." }, { "name": "-CNotMatch", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value doesn't match the specified regular expression. This operation is case-sensitive. When the input is a single object, the matched value is saved in the `$Matches` automatic variable.\n" + "description": "Indicates that this cmdlet gets objects if the property value doesn't match the specified regular expression. This operation is case-sensitive. When the input is a single object, the matched value is saved in the `$Matches` automatic variable." }, { "name": [ @@ -77,14 +77,14 @@ "-IContains" ], "isRequired": true, - "description": "Indicates that this cmdlet gets objects if any item in the property value of the object is an exact match for the specified value.\n" + "description": "Indicates that this cmdlet gets objects if any item in the property value of the object is an exact match for the specified value." }, { "name": [ "-EQ", "-IEQ" ], - "description": "Indicates that this cmdlet gets objects if the property value is the same as the specified value.\n" + "description": "Indicates that this cmdlet gets objects if the property value is the same as the specified value." }, { "name": "-FilterScript", @@ -94,7 +94,7 @@ } ], "isRequired": true, - "description": "Specifies the script block that's used to filter the objects. Enclose the script block in braces (`{}`).\n" + "description": "Specifies the scriptblock that's used to filter the objects. Enclose the scriptblock in braces (`{}`)." }, { "name": [ @@ -102,7 +102,7 @@ "-IGE" ], "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value is greater than or equal to the specified value.\n" + "description": "Indicates that this cmdlet gets objects if the property value is greater than or equal to the specified value." }, { "name": [ @@ -110,7 +110,7 @@ "-IGT" ], "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value is greater than the specified value.\n" + "description": "Indicates that this cmdlet gets objects if the property value is greater than the specified value." }, { "name": [ @@ -118,7 +118,7 @@ "-IIn" ], "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value matches any of the specified values. For example:\n" + "description": "Indicates that this cmdlet gets objects if the property value matches any of the specified values. For example:" }, { "name": "-InputObject", @@ -127,17 +127,17 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies the objects to filter. You can also pipe the objects to `Where-Object`.\n" + "description": "Specifies the objects to filter. You can also pipe the objects to `Where-Object`." }, { "name": "-Is", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value is an instance of the specified .NET type. Enclose the type name in square brackets.\n" + "description": "Indicates that this cmdlet gets objects if the property value is an instance of the specified .NET type. Enclose the type name in square brackets." }, { "name": "-IsNot", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value isn't an instance of the specified .NET type.\n" + "description": "Indicates that this cmdlet gets objects if the property value isn't an instance of the specified .NET type." }, { "name": [ @@ -145,7 +145,7 @@ "-ILE" ], "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value is less than or equal to the specified value.\n" + "description": "Indicates that this cmdlet gets objects if the property value is less than or equal to the specified value." }, { "name": [ @@ -153,7 +153,7 @@ "-ILike" ], "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value matches a value that includes wildcard characters (`*`).\n" + "description": "Indicates that this cmdlet gets objects if the property value matches a value that includes wildcard characters (`*`)." }, { "name": [ @@ -161,7 +161,7 @@ "-ILT" ], "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value is less than the specified value.\n" + "description": "Indicates that this cmdlet gets objects if the property value is less than the specified value." }, { "name": [ @@ -169,7 +169,7 @@ "-IMatch" ], "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value matches the specified regular expression. When the input is a single object, the matched value is saved in the `$Matches` automatic variable.\n" + "description": "Indicates that this cmdlet gets objects if the property value matches the specified regular expression. When the input is a single object, the matched value is saved in the `$Matches` automatic variable." }, { "name": [ @@ -177,12 +177,12 @@ "-INE" ], "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value is different than the specified value.\n" + "description": "Indicates that this cmdlet gets objects if the property value is different than the specified value." }, { "name": "-Not", "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property doesn't exist or has a value of `$null` or `$false`.\n" + "description": "Indicates that this cmdlet gets objects if the property doesn't exist or has a value of `$null` or `$false`." }, { "name": [ @@ -190,7 +190,7 @@ "-INotContains" ], "isRequired": true, - "description": "Indicates that this cmdlet gets objects if none of the items in the property value is an exact match for the specified value.\n" + "description": "Indicates that this cmdlet gets objects if none of the items in the property value is an exact match for the specified value." }, { "name": [ @@ -198,7 +198,7 @@ "-INotIn" ], "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value isn't an exact match for any of the specified values.\n" + "description": "Indicates that this cmdlet gets objects if the property value isn't an exact match for any of the specified values." }, { "name": [ @@ -206,7 +206,7 @@ "-INotLike" ], "isRequired": true, - "description": "Indicates that this cmdlet gets objects if the property value doesn't match a value that includes wildcard characters (`*`).\n" + "description": "Indicates that this cmdlet gets objects if the property value doesn't match a value that includes wildcard characters (`*`)." }, { "name": [ @@ -214,7 +214,7 @@ "-INotMatch" ], "isRequired": true, - "description": "Indicates that this cmdlet gets objects when the property value doesn't match the specified regular expression. When the input is a single object, the matched value is saved in the `$Matches` automatic variable.\n" + "description": "Indicates that this cmdlet gets objects when the property value doesn't match the specified regular expression. When the input is a single object, the matched value is saved in the `$Matches` automatic variable." }, { "name": "-Property", @@ -224,7 +224,7 @@ } ], "isRequired": true, - "description": "Specifies the name of an object property. The parameter name, Property , is optional.\n" + "description": "Specifies the name of a property of the input object. The property must be an instance property, not a static property. This is a positional parameter, so the name, Property, is optional." }, { "name": "-Value", @@ -233,7 +233,7 @@ "name": "System.Management.Automation.PSObject" } ], - "description": "Specifies a property value. The parameter name, Value , is optional. This parameter accepts wildcard characters when used with the following comparison parameters:\n" + "description": "Specifies a property value. The parameter name, Value, is optional. This parameter accepts wildcard characters when used with the following comparison parameters:" }, { "name": [ @@ -412,7 +412,7 @@ }, { "name": "-Value", - "description": "Specifies a property value. The parameter name, Value , is optional. This parameter accepts wildcard characters when used with the following comparison parameters:\n" + "description": "Specifies a property value. The parameter name, Value, is optional. This parameter accepts wildcard characters when used with the following comparison parameters:" } ], "description": "Selects objects from a collection based on their property values.", diff --git a/command-signatures/json/autogenerated/powershell/write-error.json b/command-signatures/json/autogenerated/powershell/write-error.json index 83072214..15337e9b 100644 --- a/command-signatures/json/autogenerated/powershell/write-error.json +++ b/command-signatures/json/autogenerated/powershell/write-error.json @@ -8,19 +8,22 @@ "name": "System.Management.Automation.ErrorCategory", "suggestions": [ { - "name": "NotSpecified" + "name": "AuthenticationError" }, { - "name": "OpenError" + "name": "CloseError" }, { - "name": "CloseError" + "name": "ConnectionError" + }, + { + "name": "DeadlockDetected" }, { "name": "DeviceError" }, { - "name": "DeadlockDetected" + "name": "FromStdErr" }, { "name": "InvalidArgument" @@ -37,26 +40,35 @@ { "name": "InvalidType" }, + { + "name": "LimitsExceeded" + }, { "name": "MetadataError" }, + { + "name": "NotEnabled" + }, { "name": "NotImplemented" }, { "name": "NotInstalled" }, + { + "name": "NotSpecified" + }, { "name": "ObjectNotFound" }, { - "name": "OperationStopped" + "name": "OpenError" }, { - "name": "OperationTimeout" + "name": "OperationStopped" }, { - "name": "SyntaxError" + "name": "OperationTimeout" }, { "name": "ParserError" @@ -65,49 +77,36 @@ "name": "PermissionDenied" }, { - "name": "ResourceBusy" - }, - { - "name": "ResourceExists" + "name": "ProtocolError" }, { - "name": "ResourceUnavailable" + "name": "QuotaExceeded" }, { "name": "ReadError" }, { - "name": "WriteError" - }, - { - "name": "FromStdErr" - }, - { - "name": "SecurityError" - }, - { - "name": "ProtocolError" + "name": "ResourceBusy" }, { - "name": "ConnectionError" + "name": "ResourceExists" }, { - "name": "AuthenticationError" + "name": "ResourceUnavailable" }, { - "name": "LimitsExceeded" + "name": "SecurityError" }, { - "name": "QuotaExceeded" + "name": "SyntaxError" }, { - "name": "NotEnabled" + "name": "WriteError" } - ], - "default": "NotSpecified" + ] } ], - "description": "Specifies the category of the error. The default value is NotSpecified . The acceptable values for this parameter are:\n" + "description": "Specifies the category of the error. The default value is NotSpecified. The acceptable values for this parameter are:" }, { "name": [ @@ -174,7 +173,7 @@ } ], "isRequired": true, - "description": "Specifies an error record object that represents the error. Use the properties of the object to describe the error.\n" + "description": "Specifies an error record object that represents the error. Use the properties of the object to describe the error." }, { "name": "-Exception", @@ -184,7 +183,7 @@ } ], "isRequired": true, - "description": "Specifies an exception object that represents the error. Use the properties of the object to describe the error.\n" + "description": "Specifies an exception object that represents the error. Use the properties of the object to describe the error." }, { "name": [ @@ -196,6 +195,7 @@ "name": "System.String" } ], + "isRequired": true, "description": "Specifies the message text of the error. If the text includes spaces or special characters, enclose it in quotation marks. You can also pipe a message string to `Write-Error`." }, { diff --git a/command-signatures/json/autogenerated/powershell/write-eventlog.json b/command-signatures/json/autogenerated/powershell/write-eventlog.json new file mode 100644 index 00000000..511bec26 --- /dev/null +++ b/command-signatures/json/autogenerated/powershell/write-eventlog.json @@ -0,0 +1,322 @@ +{ + "name": "Write-EventLog", + "options": [ + { + "name": "-Category", + "args": [ + { + "name": "int16" + } + ] + }, + { + "name": [ + "-ComputerName", + "-CN" + ], + "args": [ + { + "name": "string" + } + ] + }, + { + "name": [ + "-EntryType", + "-ET" + ], + "args": [ + { + "name": "EventLogEntryType", + "suggestions": [ + { + "name": "Error" + }, + { + "name": "Information" + }, + { + "name": "FailureAudit" + }, + { + "name": "SuccessAudit" + }, + { + "name": "Warning" + } + ] + } + ] + }, + { + "name": [ + "-EventId", + "-ID", + "-EID" + ], + "args": [ + { + "name": "int" + } + ], + "isRequired": true + }, + { + "name": [ + "-LogName", + "-LN" + ], + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Message", + "-MSG" + ], + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-RawData", + "-RD" + ], + "args": [ + { + "name": "byte[]" + } + ] + }, + { + "name": [ + "-Source", + "-SRC" + ], + "args": [ + { + "name": "string" + } + ], + "isRequired": true + }, + { + "name": [ + "-Debug", + "-db" + ], + "description": "Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message." + }, + { + "name": [ + "-ErrorAction", + "-ea" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error." + }, + { + "name": [ + "-ErrorVariable", + "-ev" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Error records are automatically stored in the `$Error` automatic variable. When you use the ErrorVariable parameter on a command, PowerShell also stores the error records emitted by the command in the variable specified by the parameter." + }, + { + "name": [ + "-InformationAction", + "-infa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Within the command or script in which it's used, the InformationAction common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to SilentlyContinue." + }, + { + "name": [ + "-InformationVariable", + "-iv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "When you use the InformationVariable common parameter, information records are stored in the variable specified by the parameter." + }, + { + "name": [ + "-OutBuffer", + "-ob" + ], + "args": [ + { + "name": "System.Int32" + } + ], + "description": "Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. If you omit this parameter, objects are sent as they're generated." + }, + { + "name": [ + "-OutVariable", + "-ov" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores output objects from the command in the specified variable in addition to sending the output along the pipeline." + }, + { + "name": [ + "-PipelineVariable", + "-pv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "PipelineVariable allows access to the most recent value passed into the next pipeline segment by the command that uses this parameter. Any command in the pipeline can access the value using the named PipelineVariable. The value is assigned to the variable when it's passed into the next pipeline segment." + }, + { + "name": [ + "-ProgressAction", + "-proga" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status." + }, + { + "name": [ + "-Verbose", + "-vb" + ], + "description": "Displays detailed information about the operation done by the command. This information resembles the information in a trace or in a transaction log. This parameter works only when the command generates a verbose message." + }, + { + "name": [ + "-WarningAction", + "-wa" + ], + "args": [ + { + "name": "System.Management.Automation.ActionPreference", + "suggestions": [ + "Break", + "Suspend", + "Ignore", + "Inquire", + "Continue", + "Stop", + "SilentlyContinue" + ] + } + ], + "description": "Determines how the cmdlet responds to a warning from the command. Continue is the default value. This parameter works only when the command generates a warning message." + }, + { + "name": [ + "-WarningVariable", + "-wv" + ], + "args": [ + { + "name": "System.String" + } + ], + "description": "Stores warning records about the command in the specified variable." + } + ], + "args": [ + { + "name": "-LogName" + }, + { + "name": "-Source" + }, + { + "name": "-EventId" + }, + { + "name": "-EntryType", + "suggestions": [ + { + "name": "Error" + }, + { + "name": "Information" + }, + { + "name": "FailureAudit" + }, + { + "name": "SuccessAudit" + }, + { + "name": "Warning" + } + ] + }, + { + "name": "-Message" + } + ], + "description": "Write-EventLog [-LogName] [-Source] [-EventId] [[-EntryType] ] [-Message] [-Category ] [-RawData ] [-ComputerName ] []", + "parserDirectives": { + "flagsArePosixNoncompliant": true, + "flagsMatchUniquePrefix": true, + "alwaysCaseInsensitive": true + } +} diff --git a/command-signatures/json/autogenerated/powershell/write-host.json b/command-signatures/json/autogenerated/powershell/write-host.json index 41fb1b75..6f122220 100644 --- a/command-signatures/json/autogenerated/powershell/write-host.json +++ b/command-signatures/json/autogenerated/powershell/write-host.json @@ -11,54 +11,54 @@ "name": "Black" }, { - "name": "DarkBlue" + "name": "Blue" }, { - "name": "DarkGreen" + "name": "Cyan" + }, + { + "name": "DarkBlue" }, { "name": "DarkCyan" }, { - "name": "DarkRed" + "name": "DarkGray" }, { - "name": "DarkMagenta" + "name": "DarkGreen" }, { - "name": "DarkYellow" + "name": "DarkMagenta" }, { - "name": "Gray" + "name": "DarkRed" }, { - "name": "DarkGray" + "name": "DarkYellow" }, { - "name": "Blue" + "name": "Gray" }, { "name": "Green" }, { - "name": "Cyan" + "name": "Magenta" }, { "name": "Red" }, { - "name": "Magenta" + "name": "White" }, { "name": "Yellow" - }, - { - "name": "White" } ] } ], - "description": "Specifies the background color. There is no default. The acceptable values for this parameter are:\n" + "description": "Specifies the background color. There is no default. The acceptable values for this parameter are:" }, { "name": "-ForegroundColor", @@ -70,54 +70,54 @@ "name": "Black" }, { - "name": "DarkBlue" + "name": "Blue" }, { - "name": "DarkGreen" + "name": "Cyan" + }, + { + "name": "DarkBlue" }, { "name": "DarkCyan" }, { - "name": "DarkRed" + "name": "DarkGray" }, { - "name": "DarkMagenta" + "name": "DarkGreen" }, { - "name": "DarkYellow" + "name": "DarkMagenta" }, { - "name": "Gray" + "name": "DarkRed" }, { - "name": "DarkGray" + "name": "DarkYellow" }, { - "name": "Blue" + "name": "Gray" }, { "name": "Green" }, { - "name": "Cyan" + "name": "Magenta" }, { "name": "Red" }, { - "name": "Magenta" + "name": "White" }, { "name": "Yellow" - }, - { - "name": "White" } ] } ], - "description": "Specifies the text color. There is no default. The acceptable values for this parameter are:\n" + "description": "Specifies the text color. There is no default. The acceptable values for this parameter are:" }, { "name": "-NoNewline", diff --git a/command-signatures/json/autogenerated/powershell/write-output.json b/command-signatures/json/autogenerated/powershell/write-output.json index 01db8b3d..d7358711 100644 --- a/command-signatures/json/autogenerated/powershell/write-output.json +++ b/command-signatures/json/autogenerated/powershell/write-output.json @@ -13,7 +13,7 @@ }, { "name": "-NoEnumerate", - "description": "By default, the `Write-Output` cmdlet always enumerates its output. The NoEnumerate parameter suppresses the default behavior, and prevents `Write-Output` from enumerating output. The NoEnumerate parameter has no effect if the command is wrapped in parentheses, because the parentheses force enumeration. For example, `(Write-Output 1,2,3)` still enumerates the array.\n" + "description": "By default, the `Write-Output` cmdlet always enumerates its output. The NoEnumerate parameter suppresses the default behavior, and prevents `Write-Output` from enumerating output. The NoEnumerate parameter has no effect if the command is wrapped in parentheses, because the parentheses force enumeration. For example, `(Write-Output 1,2,3 -NoEnumerate)` still enumerates the array." }, { "name": [ diff --git a/command-signatures/json/autogenerated/powershell/write-progress.json b/command-signatures/json/autogenerated/powershell/write-progress.json index 3c968f38..2cff618c 100644 --- a/command-signatures/json/autogenerated/powershell/write-progress.json +++ b/command-signatures/json/autogenerated/powershell/write-progress.json @@ -8,7 +8,6 @@ "name": "System.String" } ], - "isRequired": true, "description": "Specifies the first line of text in the heading above the status bar. This text describes the activity whose progress is being reported." }, { @@ -22,7 +21,7 @@ "name": "System.String" } ], - "description": "Specifies the line of text below the progress bar. This text describes the operation that's currently taking place." + "description": "Specifies the line of text below the progress bar in the `Classic` progress view. This text describes the operation that's currently taking place. This parameter has no effect when the progress view is set to `Minimal`." }, { "name": "-Id", @@ -67,7 +66,7 @@ "name": "System.Int32" } ], - "description": "Specifies the source of the record. You can use this in place of Id but can't be used with other parameters like ParentId ." + "description": "Specifies the source of the record. You can use this in place of Id but can't be used with other parameters like ParentId." }, { "name": "-Status", diff --git a/command-signatures/src/bin/autogenerate_powershell.rs b/command-signatures/src/bin/autogenerate_powershell.rs index e0cf7ee4..fc68b826 100644 --- a/command-signatures/src/bin/autogenerate_powershell.rs +++ b/command-signatures/src/bin/autogenerate_powershell.rs @@ -4,30 +4,90 @@ use itertools::Itertools; use rayon::prelude::*; use warp_command_signatures::{ - fig_types::Command, overrides::apply_overrides, powershell_autogenerator::CmdletHelp, + fig_types::Command, + overrides::apply_overrides, + powershell_autogenerator::{CmdletHelp, CmdletMetadataParameter}, }; fn main() { println!("Getting all Cmdlet names..."); let all_cmdlet_names = run_pwsh_command("Get-Command -Type Cmdlet | Select-Object -ExpandProperty Name"); - let all_cmdlet_names = all_cmdlet_names.trim().split('\n').collect_vec(); + let all_cmdlet_names = all_cmdlet_names.trim().lines().collect_vec(); - println!("Parsing help pages for all Cmdlets..."); + println!( + "Parsing help pages for {} Cmdlets...", + all_cmdlet_names.len() + ); let all_cmdlet_specs = all_cmdlet_names .par_iter() - .map(|cmdlet_name| { + .filter_map(|cmdlet_name| { let cmdlet_help_json = - run_pwsh_command(format!("Get-Help {cmdlet_name} | ConvertTo-Json -Depth 8")); - let cmdlet_help = serde_json::from_str::(&cmdlet_help_json) + run_pwsh_command(format!("Get-Help {cmdlet_name} | Select-Object -First 1 | ConvertTo-Json -Depth 8")); + let cmdlet_help_json = cmdlet_help_json.trim(); + + // Some cmdlets have no help available — skip them. + if cmdlet_help_json.is_empty() { + eprintln!("Skipping {cmdlet_name}: no help output"); + return None; + } + + let cmdlet_help = serde_json::from_str::(cmdlet_help_json) .unwrap_or_else(|err| panic!("failed to deserialize {cmdlet_name} help: {err:?}")); - let mut fig_command: Command = cmdlet_help.into(); + let cmdlet_metadata_json = run_pwsh_command(format!( + r#"$command = Get-Command -Name {cmdlet_name} -Type Cmdlet; +@( + $command.Parameters.Values | + Select-Object Name, + @{{ Name = 'Aliases'; Expression = {{ @($_.Aliases) }} }}, + @{{ Name = 'Suggestions'; Expression = {{ + @( + foreach ($attribute in $_.Attributes) {{ + if ($attribute -is [System.Management.Automation.ValidateSetAttribute]) {{ + $attribute.ValidValues + }} elseif ($attribute.GetType().Name -eq 'ArgumentCompletionsAttribute') {{ + $attribute.Completions + }} elseif ($attribute.GetType().Name -eq 'ArgumentEncodingCompletionsAttribute') {{ + $attribute.CompleteArgument( + '{cmdlet_name}', + $_.Name, + '', + [System.Management.Automation.Language.CommandAst]$null, + $null + ) | Select-Object -ExpandProperty CompletionText + }} + }} + if ($_.ParameterType.IsEnum) {{ + [System.Enum]::GetNames($_.ParameterType) + }} elseif ( + $_.ParameterType.IsGenericType -and + $_.ParameterType.GetGenericTypeDefinition().FullName -eq 'System.Management.Automation.FlagsExpression`1' + ) {{ + $enumType = $_.ParameterType.GenericTypeArguments[0] + if ($enumType.IsEnum) {{ + [System.Enum]::GetNames($enumType) + }} + }} + ) | Where-Object {{ $_ }} | Sort-Object -Unique + }} }} +) | ConvertTo-Json -Depth 8"# + )); + let cmdlet_metadata_json = cmdlet_metadata_json.trim(); + let cmdlet_metadata = if cmdlet_metadata_json.is_empty() { + vec![] + } else { + serde_json::from_str::>(cmdlet_metadata_json) + .unwrap_or_else(|err| { + panic!("failed to deserialize {cmdlet_name} metadata: {err:?}") + }) + }; + let mut fig_command: Command = cmdlet_help.into_fig_command(&cmdlet_metadata); apply_overrides(&mut fig_command).unwrap_or_else(|err| { panic!("unable to apply overrides for {}: {err:?}", cmdlet_name) }); - fig_command + Some(fig_command) }) .collect::>(); diff --git a/command-signatures/src/powershell_autogenerator/mod.rs b/command-signatures/src/powershell_autogenerator/mod.rs index 9ab98e29..17a13e44 100644 --- a/command-signatures/src/powershell_autogenerator/mod.rs +++ b/command-signatures/src/powershell_autogenerator/mod.rs @@ -42,6 +42,19 @@ pub struct CmdletHelp { pub syntax: SyntaxInfo, } +#[serde_as] +#[derive(Debug, Deserialize, Default)] +pub struct CmdletMetadataParameter { + #[serde(alias = "Name")] + pub name: String, + #[serde_as(deserialize_as = "DefaultOnNull>")] + #[serde(alias = "Aliases", default)] + pub aliases: Vec, + #[serde_as(deserialize_as = "DefaultOnNull>")] + #[serde(alias = "Suggestions", default)] + pub suggestions: Vec, +} + #[derive(Debug, Deserialize)] pub struct Paragraph { #[serde(alias = "Text")] @@ -60,7 +73,10 @@ pub struct Parameter { pub name: String, #[serde(rename = "type")] - pub type_info: TypeInfo, + pub type_info: Option, + + #[serde(rename = "parameterValue", default)] + pub param_value: String, #[serde(default)] pub description: Vec, diff --git a/command-signatures/src/powershell_autogenerator/to_fig_types.rs b/command-signatures/src/powershell_autogenerator/to_fig_types.rs index d7ecf281..b829df7a 100644 --- a/command-signatures/src/powershell_autogenerator/to_fig_types.rs +++ b/command-signatures/src/powershell_autogenerator/to_fig_types.rs @@ -3,15 +3,28 @@ use std::{collections::HashMap, ops::Not}; use itertools::Itertools; use warp_completion_metadata::fig_types::{ParserDirectives, StringOrNumber, Suggestion}; -use crate::powershell_autogenerator::{common_parameters::cmdlet_common_parameters, CmdletHelp}; +use crate::powershell_autogenerator::{ + common_parameters::cmdlet_common_parameters, CmdletHelp, CmdletMetadataParameter, +}; use crate::{ fig_types::{Arg, Command, CommandOption, NameOrSuggestion}, powershell_autogenerator::ParameterPosition, }; -impl From for Command { - fn from(cmdlet_help: CmdletHelp) -> Self { +fn clean_description(s: &str) -> String { + let s = s.replace(['\n', '\r'], " "); + let s = s.replace("**", ""); + s.split_whitespace().collect::>().join(" ") +} + +impl CmdletHelp { + pub fn into_fig_command(self, cmdlet_metadata: &[CmdletMetadataParameter]) -> Command { + let cmdlet_help = self; let parameters = &cmdlet_help.parameters.unwrap_or_default().parameter; + let metadata_by_name = cmdlet_metadata + .iter() + .map(|param| (param.name.as_str(), param)) + .collect::>(); // In PowerShell, all options are first-and-foremost named options. _Some_ options may // instead be provided as positional args. As we loop through the named options, we'll // collect those in this HashMap. Why a HashMap? Sometimes, multiple different params may @@ -23,8 +36,20 @@ impl From for Command { let mut options = parameters .iter() .map(|param| { + let metadata_aliases = metadata_by_name + .get(param.name.as_str()) + .map(|metadata| metadata.aliases.as_slice()) + .unwrap_or(&[]); let mut name = vec![format!("-{}", param.name)]; - name.extend(param.aliases.iter().map(|alias| format!("-{}", alias))); + name.extend( + param + .aliases + .iter() + .chain(metadata_aliases.iter()) + .filter(|alias| !alias.is_empty() && alias.as_str() != param.name) + .map(|alias| format!("-{}", alias)) + .unique(), + ); // For some reason, [`crate::powershell_autogenerator::Parameter::allowed_values`] // is always None inside [`CmdletHelp::parameters`], but it is defined inside @@ -41,14 +66,29 @@ impl From for Command { .as_ref() .is_some_and(|values| !values.values.is_empty()) }); + let suggestion_values = suggestions + .and_then(|param| param.allowed_values.as_ref()) + .map(|values| values.values.clone()) + .filter(|values| !values.is_empty()) + .or_else(|| { + metadata_by_name + .get(param.name.as_str()) + .map(|metadata| metadata.suggestions.clone()) + .filter(|values| !values.is_empty()) + }) + .unwrap_or_default(); let description = param .description .iter() .find(|param| !param.text.contains("> [!NOTE] >")) - .map(|pg| pg.text.clone()); + .map(|pg| clean_description(&pg.text)); - let type_name = ¶m.type_info.name; + let type_name = param + .type_info + .as_ref() + .map(|t| t.name.as_str()) + .unwrap_or(¶m.param_value); // "Switches", i.e. a flag without an argument, are either "SwitchParameter", // "System.Management.Automation.SwitchParameter", or "switch". @@ -58,14 +98,11 @@ impl From for Command { vec![] } else { let arg = Arg { - name: Some(type_name.clone()), + name: Some(type_name.to_string()), default: param.default_value.clone().map(StringOrNumber::String), // TODO(CORE-2677) Recognize PowerShell array syntax. is_variadic: false, - suggestions: suggestions - .and_then(|param| param.allowed_values.as_ref()) - .map(|values| values.values.clone()) - .unwrap_or_default() + suggestions: suggestion_values .into_iter() .map(|name| { NameOrSuggestion::Suggestion(Suggestion { @@ -136,7 +173,7 @@ impl From for Command { }) .collect_vec(); - Self { + Command { name: vec![cmdlet_help.name], // PowerShell cmdlets don't have subcommands. subcommands: vec![], @@ -144,7 +181,7 @@ impl From for Command { args, alias_generator: None, additional_suggestions: vec![], - description: Some(cmdlet_help.synopsis), + description: Some(clean_description(&cmdlet_help.synopsis)), is_dangerous: false, priority: None, hidden: false,