Skip to content

Commit 0dcc6b3

Browse files
authored
Documentation improvement to Az.StackHCI (Azure#13988)
* Fix example format of Register-AzStackHCI * module description * Update Register-AzStackHCI.md * exit 0
1 parent 67395f3 commit 0dcc6b3

File tree

4 files changed

+19
-18
lines changed

4 files changed

+19
-18
lines changed

src/StackHCI/Az.StackHCI.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ CompanyName = 'Microsoft Corporation'
3030
Copyright = 'Microsoft Corporation. All rights reserved.'
3131

3232
# Description of the functionality provided by this module
33-
Description = 'Microsoft Azure PowerShell: StackHCI cmdlets'
33+
Description = 'Microsoft Azure PowerShell: Azure Stack HCI registration cmdlets'
3434

3535
# Minimum version of the PowerShell engine required by this module
3636
PowerShellVersion = '5.1'

src/StackHCI/help/Az.StackHCI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Locale: en-US
88

99
# Az.StackHCI Module
1010
## Description
11-
Microsoft Azure PowerShell: StackHCI cmdlets
11+
Microsoft Azure PowerShell: Azure Stack HCI registration cmdlets
1212

1313
## Az.StackHCI Cmdlets
1414
### [Register-AzStackHCI](Register-AzStackHCI.md)

src/StackHCI/help/Register-AzStackHCI.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,48 +26,48 @@ Register-AzStackHCI creates a Microsoft.AzureStackHCI cloud resource representin
2626
## EXAMPLES
2727

2828
### EXAMPLE 1
29-
```
30-
Invoking on one of the cluster node.
31-
```
32-
29+
```powershell
3330
C:\PS\>Register-AzStackHCI -SubscriptionId "12a0f531-56cb-4340-9501-257726d741fd"
3431
Result: Success
3532
ResourceId: /subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/DemoHCICluster1-rg/providers/Microsoft.AzureStackHCI/clusters/DemoHCICluster1
3633
PortalResourceURL: https://portal.azure.com/#@c31c0dbb-ce27-4c78-ad26-a5f717c14557/resource/subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/DemoHCICluster1-rg/providers/Microsoft.AzureStackHCI/clusters/DemoHCICluster1/overview
3734
PortalAADAppPermissionsURL: https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationMenuBlade/CallAnAPI/appId/980be58d-578c-4cff-b4cd-43e9c3a77826/isMSAApp/
38-
39-
### EXAMPLE 2
40-
```
41-
Invoking from the management node
4235
```
4336

37+
Invoking on one of the cluster node.
38+
39+
### EXAMPLE 2
40+
```powershell
4441
C:\PS\>Register-AzStackHCI -SubscriptionId "12a0f531-56cb-4340-9501-257726d741fd" -ComputerName ClusterNode1
4542
Result: Success
4643
ResourceId: /subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/DemoHCICluster2-rg/providers/Microsoft.AzureStackHCI/clusters/DemoHCICluster2
4744
PortalResourceURL: https://portal.azure.com/#@c31c0dbb-ce27-4c78-ad26-a5f717c14557/resource/subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/DemoHCICluster2-rg/providers/Microsoft.AzureStackHCI/clusters/DemoHCICluster2/overview
4845
PortalAADAppPermissionsURL: https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationMenuBlade/CallAnAPI/appId/950be58d-578c-4cff-b4cd-43e9c3a77866/isMSAApp/
49-
50-
### EXAMPLE 3
51-
```
52-
Invoking from WAC
5346
```
5447

48+
Invoking from the management node.
49+
50+
### EXAMPLE 3
51+
```powershell
5552
C:\PS\>Register-AzStackHCI -SubscriptionId "12a0f531-56cb-4340-9501-257726d741fd" -ArmAccessToken etyer..ere= -GraphAccessToken acyee..rerrer -AccountId [email protected] -Region westus -ResourceName DemoHCICluster3 -ResourceGroupName DemoHCIRG
5653
Result: PendingForAdminConsent
5754
ResourceId: /subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/DemoHCIRG/providers/Microsoft.AzureStackHCI/clusters/DemoHCICluster3
5855
PortalResourceURL: https://portal.azure.com/#@c31c0dbb-ce27-4c78-ad26-a5f717c14557/resource/subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/DemoHCIRG/providers/Microsoft.AzureStackHCI/clusters/DemoHCICluster3/overview
5956
PortalAADAppPermissionsURL: https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationMenuBlade/CallAnAPI/appId/980be58d-578c-4cff-b4cd-43e9c3a77866/isMSAApp/
60-
61-
### EXAMPLE 4
62-
```
63-
Invoking with all the parameters
6457
```
6558

59+
Invoking from WAC.
60+
61+
### EXAMPLE 4
62+
```powershell
6663
C:\PS\>Register-AzStackHCI -SubscriptionId "12a0f531-56cb-4340-9501-257726d741fd" -Region westus -ResourceName HciCluster1 -TenantId "c31c0dbb-ce27-4c78-ad26-a5f717c14557" -ResourceGroupName HciClusterRG -ArmAccessToken eerrer..ere= -GraphAccessToken acee..rerrer -AccountId [email protected] -EnvironmentName AzureCloud -ComputerName node1hci -Credential Get-Credential
6764
Result: Success
6865
ResourceId: /subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/HciClusterRG/providers/Microsoft.AzureStackHCI/clusters/HciCluster1
6966
PortalResourceURL: https://portal.azure.com/#@c31c0dbb-ce27-4c78-ad26-a5f717c14557/resource/subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/HciClusterRG/providers/Microsoft.AzureStackHCI/clusters/HciCluster1/overview
7067
PortalAADAppPermissionsURL: https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationMenuBlade/CallAnAPI/appId/990be58d-578c-4cff-b4cd-43e9c3a77866/isMSAApp/
68+
```
69+
70+
Invoking with all the parameters.
7171

7272
## PARAMETERS
7373

src/StackHCI/test-module.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
exit 0

0 commit comments

Comments
 (0)