From 1a4391b3dff9b471b060831696be508d0c4e49c2 Mon Sep 17 00:00:00 2001 From: zyxyoshine Date: Thu, 29 Nov 2018 15:49:06 +0800 Subject: [PATCH] add help md files for new cmdlet --- .../Azs.Fabric.Admin/Help/Azs.Fabric.Admin.md | 13 +- .../Azs.Fabric.Admin/Help/Get-AzsDrive.md | 199 ++++++++++++++++++ .../Help/Get-AzsStorageSubSystem.md | 184 ++++++++++++++++ .../Azs.Fabric.Admin/Help/Get-AzsVolume.md | 199 ++++++++++++++++++ 4 files changed, 593 insertions(+), 2 deletions(-) create mode 100644 src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsDrive.md create mode 100644 src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsStorageSubSystem.md create mode 100644 src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsVolume.md diff --git a/src/StackAdmin/Azs.Fabric.Admin/Help/Azs.Fabric.Admin.md b/src/StackAdmin/Azs.Fabric.Admin/Help/Azs.Fabric.Admin.md index 91b1c1614e2e..8e934aa1936c 100644 --- a/src/StackAdmin/Azs.Fabric.Admin/Help/Azs.Fabric.Admin.md +++ b/src/StackAdmin/Azs.Fabric.Admin/Help/Azs.Fabric.Admin.md @@ -20,6 +20,9 @@ Start maintenance mode for a scale unit node. ### [Enable-AzsScaleUnitNode](Enable-AzsScaleUnitNode.md) Stop maintenance mode for a scale unit node. +### [Get-AzsDrive](Get-AzsDrive.md) +Returns a list of all storage drives for a given cluster. + ### [Get-AzsEdgeGateway](Get-AzsEdgeGateway.md) Returns the list of all edge gateways at a certain location. @@ -38,8 +41,8 @@ Returns a list of all infrastructure role instances at a location. ### [Get-AzsInfrastructureShare](Get-AzsInfrastructureShare.md) Returns a list of all fabric file shares at a certain location. -### [Get-AzsInfrastructureVolume](Get-AzsInfrastructureVolume.md) -Returns a list of all storage volumes at a location. +### [Get-AzsInfrastructureVolume](Get-AzsVolume.md) +Returns a list of all storage volumes at a location (Get-AzsInfrastructureVolume is an alias now to the cmdlet Get-AzsVolume). ### [Get-AzsIpPool](Get-AzsIpPool.md) Returns a list of all IP pools at a certain location. @@ -65,9 +68,15 @@ Returns a list of all software load balancer instances at a location. ### [Get-AzsStoragePool](Get-AzsStoragePool.md) Returns a list of all storage pools for a location. +### [Get-AzsStorageSubSystem](Get-AzsStorageSubSystem.md) +Returns a list of all storage subsystems for a location. + ### [Get-AzsStorageSystem](Get-AzsStorageSystem.md) Returns a list of all storage subsystems for a location. +### [Get-AzsVolume](Get-AzsVolume.md) +Returns a list of all storage volumes at a location. + ### [New-AzsIpPool](New-AzsIpPool.md) Create an infrastructure IP pool. Once created an IP pool cannot be deleted or modified. diff --git a/src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsDrive.md b/src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsDrive.md new file mode 100644 index 000000000000..d51e316c1efa --- /dev/null +++ b/src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsDrive.md @@ -0,0 +1,199 @@ +--- +external help file: Azs.Fabric.Admin-help.xml +Module Name: Azs.Fabric.Admin +online version: +schema: 2.0.0 +--- + +# Get-AzsDrive + +## SYNOPSIS +Returns a list of all storage drives for a given cluster. + +## SYNTAX + +### List (Default) +``` +Get-AzsDrive -StorageSubSystem -ScaleUnit [-Location ] [-ResourceGroupName ] + [-Filter ] [-Skip ] [-Top ] [] +``` + +### Get +``` +Get-AzsDrive -Name -StorageSubSystem -ScaleUnit [-Location ] + [-ResourceGroupName ] [] +``` + +### ResourceId +``` +Get-AzsDrive -ResourceId [] +``` + +## DESCRIPTION +Returns a list of all storage drives for a given cluster. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +``` +Get-AzsDrive -ScaleUnit S-Cluster -StorageSubSystem S-Cluster.azurestack.local +``` + +Get a list of all storage drives for a given cluster. + +### -------------------------- EXAMPLE 2 -------------------------- +``` +Get-AzsDrive -ScaleUnit S-Cluster -StorageSubSystem S-Cluster.azurestack.local -Name a654528c-60bb-18e1-457c-51b7cdb7e14a +``` + +Get a storage drive by name for a given cluster. + +## PARAMETERS + +### -Filter +OData filter parameter. + +```yaml +Type: String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the resource. + +```yaml +Type: String +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the storage drive. + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group in which the resource provider has been registered. + +```yaml +Type: String +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id. + +```yaml +Type: String +Parameter Sets: ResourceId +Aliases: id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScaleUnit +Name of the scale unit. + +```yaml +Type: String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSubSystem +Storage subsystem in which the drive is located. + +```yaml +Type: String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Return the top N items as specified by the parameter value. +Applies after the -Skip parameter. + +```yaml +Type: Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: -1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skip the first N items as specified by the parameter value. + +```yaml +Type: Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: -1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.AzureStack.Management.Fabric.Admin.Models.Drive +## NOTES + +## RELATED LINKS diff --git a/src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsStorageSubSystem.md b/src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsStorageSubSystem.md new file mode 100644 index 000000000000..d5821be2a71c --- /dev/null +++ b/src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsStorageSubSystem.md @@ -0,0 +1,184 @@ +--- +external help file: Azs.Fabric.Admin-help.xml +Module Name: Azs.Fabric.Admin +online version: +schema: 2.0.0 +--- + +# Get-AzsStorageSubSystem + +## SYNOPSIS +Returns a list of all storage subsystems for a location. + +## SYNTAX + +### List (Default) +``` +Get-AzsStorageSubSystem -ScaleUnit [-Location ] [-ResourceGroupName ] + [-Filter ] [-Skip ] [-Top ] [] +``` + +### Get +``` +Get-AzsStorageSubSystem [-Name] -ScaleUnit [-Location ] [-ResourceGroupName ] + [] +``` + +### ResourceId +``` +Get-AzsStorageSubSystem -ResourceId [] +``` + +## DESCRIPTION +Returns a list of all storage subsystems for a location. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +``` +Get-AzsStorageSubSystem -ScaleUnit S-Cluster +``` + +Get all storage subsystems from a location. + +### -------------------------- EXAMPLE 2 -------------------------- +``` +Get-AzsStorageSubSystem -ScaleUnit S-Cluster -Name S-Cluster.azurestack.local +``` + +Get a storage subsystem given a location and name. + +## PARAMETERS + +### -Filter +OData filter parameter. + +```yaml +Type: String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the resource. + +```yaml +Type: String +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the storage subsystem. + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group in which the resource provider has been registered. + +```yaml +Type: String +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id. + +```yaml +Type: String +Parameter Sets: ResourceId +Aliases: id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScaleUnit +Name of the scale unit. + +```yaml +Type: String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Return the top N items as specified by the parameter value. +Applies after the -Skip parameter. + +```yaml +Type: Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: -1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skip the first N items as specified by the parameter value. + +```yaml +Type: Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: -1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.AzureStack.Management.Fabric.Admin.Models.StorageSubSystem +## NOTES + +## RELATED LINKS diff --git a/src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsVolume.md b/src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsVolume.md new file mode 100644 index 000000000000..82aeba1c50ee --- /dev/null +++ b/src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsVolume.md @@ -0,0 +1,199 @@ +--- +external help file: Azs.Fabric.Admin-help.xml +Module Name: Azs.Fabric.Admin +online version: +schema: 2.0.0 +--- + +# Get-AzsVolume + +## SYNOPSIS +Returns a list of all storage volumes at a location. + +## SYNTAX + +### List (Default) +``` +Get-AzsVolume -StorageSubSystem -ScaleUnit [-Location ] [-ResourceGroupName ] + [-Filter ] [-Skip ] [-Top ] [] +``` + +### Get +``` +Get-AzsVolume -Name -StorageSubSystem -ScaleUnit [-Location ] + [-ResourceGroupName ] [] +``` + +### ResourceId +``` +Get-AzsVolume -ResourceId [] +``` + +## DESCRIPTION +Returns a list of all storage volumes at a location. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +``` +Get-AzsVolume -ScaleUnit S-Cluster -StorageSubSystem S-Cluster.azurestack.local +``` + +Get a list of all storage volumes at a given location. + +### -------------------------- EXAMPLE 2 -------------------------- +``` +Get-AzsVolume -ScaleUnit S-Cluster -StorageSubSystem S-Cluster.azurestack.local -Name a42d219b +``` + +Get a storage volume by name at a given location. + +## PARAMETERS + +### -Filter +OData filter parameter. + +```yaml +Type: String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the resource. + +```yaml +Type: String +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the storage volume. + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group in which the resource provider has been registered. + +```yaml +Type: String +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id. + +```yaml +Type: String +Parameter Sets: ResourceId +Aliases: id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScaleUnit +Name of the scale unit. + +```yaml +Type: String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSubSystem +Storage subsystem in which the volume is located. + +```yaml +Type: String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Return the top N items as specified by the parameter value. +Applies after the -Skip parameter. + +```yaml +Type: Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: -1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skip the first N items as specified by the parameter value. + +```yaml +Type: Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: -1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.AzureStack.Management.Fabric.Admin.Models.Volume +## NOTES + +## RELATED LINKS