Skip to content

Fix Input descriptions #6884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 9, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions documentation/development-docs/help-generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ Get-ChildItem -Path $PathToHelpFolder | Update-MarkdownHelp -AlphabeticParamsOrd

This will update all of the markdown files with public interface changes made to corresponding cmdlets, add markdown files for any new cmdlets, remove markdown files for any deleted cmdlets, and update the module page (_e.g.,_ `AzureRM.Profile.md`) with any added or removed cmdlets.

_This seems to work better when run from within the `help` folder itself (For e.g. to generate the help files for the [`Network`](https://github.com/Azure/azure-powershell/tree/preview/src/ResourceManager/Network) module run the cmd from under [`Commands.Network/help`](https://github.com/Azure/azure-powershell/tree/preview/src/ResourceManager/Network/Commands.Network/help)). Also, you will have to import the profile module from under <Repo base path>/src/Package/Debug/ResourceManager/AzureResourceManager/AzureRM.Profile/AzureRM.Profile.psd1_

#### Updating a single markdown file

To update a single markdown file with the changes made to the corresponding cmdlet, use the [`Update-MarkdownHelp`](https://github.com/PowerShell/platyPS/blob/master/docs/Update-MarkdownHelp.md) cmdlet:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### System.String
Parameters: Id (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
Parameters: InputObject (ByValue)

### System.String
Parameters: Id (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
Parameters: InputObject (ByValue)

### System.String
Parameters: Id (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
Parameters: InputObject (ByValue)

### System.String
Parameters: Id (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
Parameters: InputObject (ByValue)

### System.String
Parameters: Id (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### System.String
Parameters: Name (ByPropertyName), ResourceGroupName (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallRule, Microsoft.Azure.Commands.AnalysisServices, Version=0.6.10.0, Culture=neutral, PublicKeyToken=null]]
### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallRule, Microsoft.Azure.Commands.AnalysisServices, Version=0.6.11.0, Culture=neutral, PublicKeyToken=null]]

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### System.String
Parameters: FirewallRuleName (ByPropertyName), RangeEnd (ByPropertyName), RangeStart (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -252,16 +252,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### System.String
Parameters: Administrator (ByPropertyName), BackupBlobContainerUri (ByPropertyName), DefaultConnectionMode (ByPropertyName), GatewayResourceId (ByPropertyName), Location (ByPropertyName), Name (ByPropertyName), ResourceGroupName (ByPropertyName), Sku (ByPropertyName)

### System.Collections.Hashtable
Parameters: Tag (ByPropertyName)

### System.Int32
Parameters: ReadonlyReplicaCount (ByPropertyName)

### Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallConfig
Parameters: FirewallConfig (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### System.String
Parameters: Name (ByPropertyName), ResourceGroupName (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### System.String
Parameters: Name (ByPropertyName), ResourceGroupName (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -302,19 +302,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### System.String
Parameters: Administrator (ByPropertyName), BackupBlobContainerUri (ByPropertyName), DefaultConnectionMode (ByPropertyName), GatewayResourceId (ByPropertyName), Name (ByPropertyName), ResourceGroupName (ByPropertyName), Sku (ByPropertyName)

### System.Collections.Hashtable
Parameters: Tag (ByPropertyName)

### System.Management.Automation.SwitchParameter
Parameters: DisableBackup (ByPropertyName), DisassociateGateway (ByPropertyName)

### System.Int32
Parameters: ReadonlyReplicaCount (ByPropertyName)

### Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallConfig
Parameters: FirewallConfig (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### System.String
Parameters: Name (ByPropertyName), ResourceGroupName (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### System.String
Parameters: Name (ByPropertyName), ResourceGroupName (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: ApiId (ByPropertyName), ProductId (ByPropertyName)

### System.Management.Automation.SwitchParameter
Parameters: PassThru (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,13 +118,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: GroupId (ByPropertyName), ProductId (ByPropertyName)

### System.Management.Automation.SwitchParameter
Parameters: PassThru (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: GroupId (ByPropertyName), UserId (ByPropertyName)

### System.Management.Automation.SwitchParameter
Parameters: PassThru (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,10 +152,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### System.String
Parameters: Name (ByPropertyName), ResourceGroupName (ByPropertyName)

### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext
Parameters: StorageContext (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,16 +201,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: ApiId (ByPropertyName), ApiRevision (ByPropertyName), SaveAs (ByPropertyName)

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiFormat
Parameters: SpecificationFormat (ByPropertyName)

### System.Management.Automation.SwitchParameter
Parameters: Force (ByPropertyName), PassThru (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### System.String
Parameters: Name (ByPropertyName), ResourceGroupName (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,10 +164,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: ApiId (ByPropertyName), ApiRevision (ByPropertyName), Name (ByPropertyName), ProductId (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: ApiId (ByPropertyName), ReleaseId (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: ApiId (ByPropertyName), ApiRevision (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: ApiVersionSetId (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: ServerId (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: BackendId (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,10 +130,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: CertificateId (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,10 +176,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: GroupId (ByPropertyName), Name (ByPropertyName), ProductId (ByPropertyName), UserId (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType
Parameters: Type (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: LoggerId (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,10 +130,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: Name (ByPropertyName), OpenIdConnectProviderId (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: ApiId (ByPropertyName), ApiRevision (ByPropertyName), OperationId (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,13 +255,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: ApiId (ByPropertyName), ApiRevision (ByPropertyName), Format (ByPropertyName), OperationId (ByPropertyName), ProductId (ByPropertyName), SaveAs (ByPropertyName)

### System.Management.Automation.SwitchParameter
Parameters: Force (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: ProductId (ByPropertyName), Title (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameters: Context (ByPropertyName)

### System.String
Parameters: Name (ByPropertyName), PropertyId (ByPropertyName), Tag (ByPropertyName)

## OUTPUTS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### System.String
Parameters: Name (ByPropertyName), ResourceGroupName (ByPropertyName)

## OUTPUTS

Expand Down
Loading