Skip to content

Commit 5ff877b

Browse files
authored
Merge pull request #30 from deathly809/preview
Fixed documentation and an cmdlet name
2 parents d6652ba + 7013eeb commit 5ff877b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+343
-84
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
Module Name: Azs.Commerce.Admin
3+
Module Guid: 2860bcbc-08eb-4667-9277-269bcf727c5a
4+
Download Help Link:
5+
Help Version: 0.1.0
6+
Locale: en-US
7+
---
8+
9+
# Azs.Commerce.Admin Module
10+
## Description
11+
Allows AzureStack administrators to view aggregate subscription usage.
12+
13+
## Azs.Commerce.Admin Cmdlets
14+
### [Get-AzsSubscriberUsageAggregate](Get-AzsSubscriberUsageAggregate.md)
15+
Gets a collection of SubscriberUsageAggregate, which are UsageAggregates from direct tenants.
16+

src/StackAdmin/Azs.Commerce.Admin/Help/Get-AzsSubscriberUsageAggregate.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Gets a collection of SubscriberUsageAggregate, which are UsageAggregates from di
1515
```
1616
Get-AzsSubscriberUsageAggregate [-SubscriberId <String>] -ReportedStartTime <DateTime>
1717
[-AggregationGranularity <String>] -ReportedEndTime <DateTime> [-ContinuationToken <String>]
18+
[<CommonParameters>]
1819
```
1920

2021
## DESCRIPTION
@@ -115,6 +116,9 @@ Accept pipeline input: False
115116
Accept wildcard characters: False
116117
```
117118
119+
### CommonParameters
120+
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).
121+
118122
## INPUTS
119123
120124
## OUTPUTS

src/StackAdmin/Azs.Commerce.Admin/Module/Azs.Commerce.Admin/Azs.Commerce.Admin.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ PrivateData = @{
110110
# IconUri = ''
111111

112112
# ReleaseNotes of this module
113-
ReleaseNotes = 'Initial release of the Commerce Admin module. Allows administrators to view aggregate subscription usage.'
113+
ReleaseNotes = 'Initial release of the Commerce Admin module. Allows AzureStack administrators to view aggregate subscription usage.'
114114

115115
# Flag to indicate whether the module requires explicit user acceptance for install/update
116116
# RequireLicenseAcceptance = $false
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
Module Name: Azs.Fabric.Admin
3+
Module Guid: 5e04dc01-069b-4fad-a590-ccff2c6e20b5
4+
Download Help Link:
5+
Help Version: 0.1.0
6+
Locale: en-US
7+
---
8+
9+
# Azs.Fabric.Admin Module
10+
## Description
11+
Allows AzureStack administrators view and manage their infrastructure.
12+
13+
## Azs.Fabric.Admin Cmdlets
14+
### [Disable-AzsInfrastructureRoleInstance](Disable-AzsInfrastructureRoleInstance.md)
15+
Shut down an infrastructure role instance. On failure an exception is thrown.
16+
17+
### [Disable-AzsScaleUnitNode](Disable-AzsScaleUnitNode.md)
18+
Start maintenance mode for a scale unit node. This begins the process of moving all resources off the node.
19+
20+
### [Enable-AzsScaleUnitNode](Enable-AzsScaleUnitNode.md)
21+
Stop maintenance mode for a scale unit node.
22+
23+
### [Get-AzsComputeInfrastructureOperation](Get-AzsComputeInfrastructureOperation.md)
24+
Get the status of a compute fabric operation.
25+
26+
### [Get-AzsEdgeGateway](Get-AzsEdgeGateway.md)
27+
Get edge gateways.
28+
29+
### [Get-AzsEdgeGatewayPool](Get-AzsEdgeGatewayPool.md)
30+
Get edge gateway pools.
31+
32+
### [Get-AzsInfrastructureLocation](Get-AzsInfrastructureLocation.md)
33+
Get a list of all fabric locations.
34+
35+
### [Get-AzsInfrastructureRole](Get-AzsInfrastructureRole.md)
36+
Get infrastructure roles.
37+
38+
### [Get-AzsInfrastructureRoleInstance](Get-AzsInfrastructureRoleInstance.md)
39+
Get a list of infrastructure role instances.
40+
41+
### [Get-AzsInfrastructureShare](Get-AzsInfrastructureShare.md)
42+
Get file shares.
43+
44+
### [Get-AzsInfrastructureVolume](Get-AzsInfrastructureVolume.md)
45+
Get volumes at a location.
46+
47+
### [Get-AzsIpPool](Get-AzsIpPool.md)
48+
Get infrastructure ip pools.
49+
50+
### [Get-AzsLogicalNetwork](Get-AzsLogicalNetwork.md)
51+
Get logical networks from a given location.
52+
53+
### [Get-AzsLogicalSubnet](Get-AzsLogicalSubnet.md)
54+
Get logical subnets under a logical network at a specific location.
55+
56+
### [Get-AzsMacAddressPool](Get-AzsMacAddressPool.md)
57+
Get MAC address pools at a certain location.
58+
59+
### [Get-AzsNetworkInfrastructureOperation](Get-AzsNetworkInfrastructureOperation.md)
60+
Get the status of a network fabric operation.
61+
62+
### [Get-AzsScaleUnit](Get-AzsScaleUnit.md)
63+
Get scale units.
64+
65+
### [Get-AzsScaleUnitNode](Get-AzsScaleUnitNode.md)
66+
Get scale unit nodes at a certain location.
67+
68+
### [Get-AzsSlbMuxInstance](Get-AzsSlbMuxInstance.md)
69+
Get software load balanacer multiplexer instances at a certain location.
70+
71+
### [Get-AzsStoragePool](Get-AzsStoragePool.md)
72+
Get storage pools at a location.
73+
74+
### [Get-AzsStorageSystem](Get-AzsStorageSystem.md)
75+
Get storage subsystems given a location.
76+
77+
### [New-AzsIpPool](New-AzsIpPool.md)
78+
Create an infrastructure ip pool.
79+
80+
### [New-AzsIpPoolObject](New-AzsIpPoolObject.md)
81+
This resource defines the range of IP addresses from which addresses are allocated for nodes within a subnet.
82+
83+
### [Restart-AzsInfrastructureRoleInstance](Restart-AzsInfrastructureRoleInstance.md)
84+
Reboot an infrastructure role instance. On failure an exception is thrown.
85+
86+
### [Start-AzsInfrastructureRoleInstance](Start-AzsInfrastructureRoleInstance.md)
87+
Power on an infrastructure role instance. On failure an exception is thrown.
88+
89+
### [Start-AzsScaleUnitNode](Start-AzsScaleUnitNode.md)
90+
Power on a scale unit node.
91+
92+
### [Stop-AzsInfrastructureRoleInstance](Stop-AzsInfrastructureRoleInstance.md)
93+
Power off an infrastructure role instance. On failure an exception is thrown.
94+
95+
### [Stop-AzsScaleUnitNode](Stop-AzsScaleUnitNode.md)
96+
Power off a scale unit node. This will turn off your physical machine and should be used with extreme caution.
97+

src/StackAdmin/Azs.Fabric.Admin/Help/Disable-AzsInfrastructureRoleInstance.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Shut down an infrastructure role instance. On failure an exception is thrown.
1414

1515
```
1616
Disable-AzsInfrastructureRoleInstance -InfrastructureRoleInstance <String> -Location <String> [-AsJob]
17+
[<CommonParameters>]
1718
```
1819

1920
## DESCRIPTION
@@ -79,6 +80,9 @@ Accept pipeline input: False
7980
Accept wildcard characters: False
8081
```
8182
83+
### CommonParameters
84+
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).
85+
8286
## INPUTS
8387
8488
## OUTPUTS

src/StackAdmin/Azs.Fabric.Admin/Help/Disable-AzsScaleUnitNode.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Start maintenance mode for a scale unit node. This begins the process of moving
1313
## SYNTAX
1414

1515
```
16-
Disable-AzsScaleUnitNode -ScaleUnitNode <String> -Location <String> [-AsJob]
16+
Disable-AzsScaleUnitNode -ScaleUnitNode <String> -Location <String> [-AsJob] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -79,6 +79,9 @@ Accept pipeline input: False
7979
Accept wildcard characters: False
8080
```
8181
82+
### CommonParameters
83+
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).
84+
8285
## INPUTS
8386
8487
## OUTPUTS

src/StackAdmin/Azs.Fabric.Admin/Help/Enable-AzsScaleUnitNode.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Stop maintenance mode for a scale unit node.
1313
## SYNTAX
1414

1515
```
16-
Enable-AzsScaleUnitNode -ScaleUnitNode <String> -Location <String> [-AsJob]
16+
Enable-AzsScaleUnitNode -ScaleUnitNode <String> -Location <String> [-AsJob] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -79,6 +79,9 @@ Accept pipeline input: False
7979
Accept wildcard characters: False
8080
```
8181
82+
### CommonParameters
83+
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).
84+
8285
## INPUTS
8386
8487
## OUTPUTS

src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsComputeInfrastructureOperation.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@ online version:
55
schema: 2.0.0
66
---
77

8-
# Get-AzsComputeFabricOperation
8+
# Get-AzsComputeInfrastructureOperation
99

1010
## SYNOPSIS
1111
Get the status of a compute fabric operation.
1212

1313
## SYNTAX
1414

1515
```
16-
Get-AzsComputeFabricOperation -ComputeOperationResult <String> -Provider <String> -Location <String>
16+
Get-AzsComputeInfrastructureOperation -ComputeOperationResult <String> -Provider <String> -Location <String>
17+
[<CommonParameters>]
1718
```
1819

1920
## DESCRIPTION
@@ -23,7 +24,7 @@ Get the status of a compute fabric operation.
2324

2425
### Example 1
2526
```
26-
PS C:\> Get-AzsComputeFabricOperation -Location "local" -Provider "Microsoft.Fabric.Admin" -ComputeOperationResult "fdcdefb6-6fd0-402c-8b0c-5765b8fc4dc1"
27+
PS C:\> Get-AzsComputeInfrastructureOperation -Location "local" -Provider "Microsoft.Fabric.Admin" -ComputeOperationResult "fdcdefb6-6fd0-402c-8b0c-5765b8fc4dc1"
2728
2829
ProvisioningState
2930
-----------------------
@@ -79,6 +80,9 @@ Accept pipeline input: False
7980
Accept wildcard characters: False
8081
```
8182
83+
### CommonParameters
84+
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).
85+
8286
## INPUTS
8387
8488
## OUTPUTS

src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsEdgeGateway.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ Get edge gateways.
1414

1515
### EdgeGateways_List (Default)
1616
```
17-
Get-AzsEdgeGateway [-Filter <String>] [-Skip <Int32>] -Location <String> [-Top <Int32>]
17+
Get-AzsEdgeGateway [-Filter <String>] [-Skip <Int32>] -Location <String> [-Top <Int32>] [<CommonParameters>]
1818
```
1919

2020
### EdgeGateways_Get
2121
```
22-
Get-AzsEdgeGateway -EdgeGateway <String> -Location <String>
22+
Get-AzsEdgeGateway -EdgeGateway <String> -Location <String> [<CommonParameters>]
2323
```
2424

2525
## DESCRIPTION
@@ -46,7 +46,6 @@ PS C:\> Get-AzsEdgeGateway -Location "local" -EdgeGateway "AzS-Gwy01"
4646
Type State TotalCapacity Name AvailableCapacity
4747
---- ----- ------------- ---- -----------------
4848
Microsoft.Fabric.Admin/fabricLocations/edgeGateways Active 100000000 AzS-Gwy01 100000000
49-
5049
```
5150

5251
Get a specific edge gateway.
@@ -129,6 +128,9 @@ Accept pipeline input: False
129128
Accept wildcard characters: False
130129
```
131130
131+
### CommonParameters
132+
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).
133+
132134
## INPUTS
133135
134136
## OUTPUTS

src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsEdgeGatewayPool.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ Get edge gateway pools.
1515
### EdgeGatewayPools_List (Default)
1616
```
1717
Get-AzsEdgeGatewayPool [-Filter <String>] [-Skip <Int32>] -Location <String> [-Top <Int32>]
18+
[<CommonParameters>]
1819
```
1920

2021
### EdgeGatewayPools_Get
2122
```
22-
Get-AzsEdgeGatewayPool -EdgeGatewayPool <String> -Location <String>
23+
Get-AzsEdgeGatewayPool -EdgeGatewayPool <String> -Location <String> [<CommonParameters>]
2324
```
2425

2526
## DESCRIPTION
@@ -35,20 +36,17 @@ GatewayCapacityKiloBitsPerSecond Type
3536
-------------------------------- ---- ------------ --------------- ------------
3637
100000000 Microsoft.Fabric.Admin/fabricLocations/edgeGatewayPools 00000000-5555-0000-0001-000000000000 {AzS-Gwy01}
3738
200000000 Microsoft.Fabric.Admin/fabricLocations/edgeGatewayPools 00000000-4444-0000-0001-000000000000 {AzS-Gwy02}
38-
3939
```
4040

4141
Get a list of all Edge Gateway pools.
4242

4343
### Example 2
44-
4544
```
4645
PS C:\> Get-AzsEdgeGatewayPool -Location "local" -EdgeGatewayPool "AzS-Gwy01"
4746
4847
GatewayCapacityKiloBitsPerSecond Type GreVipSubnet PublicIpAddress EdgeGateways
4948
-------------------------------- ---- ------------ --------------- ------------
5049
100000000 Microsoft.Fabric.Admin/fabricLocations/edgeGatewayPools 00000000-5555-0000-0001-000000000000 {AzS-Gwy01}
51-
5250
```
5351

5452
Get a specific edge gateway pool.
@@ -131,6 +129,9 @@ Accept pipeline input: False
131129
Accept wildcard characters: False
132130
```
133131
132+
### CommonParameters
133+
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).
134+
134135
## INPUTS
135136
136137
## OUTPUTS

src/StackAdmin/Azs.Fabric.Admin/Help/Get-AzsInfrastructureLocation.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ Get a list of all fabric locations.
1515
### FabricLocations_List (Default)
1616
```
1717
Get-AzsInfrastructureLocation [-Filter <String>] [-Skip <Int32>] -Location <String> [-Top <Int32>]
18+
[<CommonParameters>]
1819
```
1920

2021
### FabricLocations_Get
2122
```
22-
Get-AzsInfrastructureLocation -FabricLocation <String> -Location <String>
23+
Get-AzsInfrastructureLocation -FabricLocation <String> -Location <String> [<CommonParameters>]
2324
```
2425

2526
## DESCRIPTION
@@ -117,6 +118,9 @@ Accept pipeline input: False
117118
Accept wildcard characters: False
118119
```
119120
121+
### CommonParameters
122+
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).
123+
120124
## INPUTS
121125
122126
## OUTPUTS

0 commit comments

Comments
 (0)