Skip to content

Commit 8c141ad

Browse files
committed
More freshness
1 parent 6c259df commit 8c141ad

File tree

2 files changed

+36
-44
lines changed

2 files changed

+36
-44
lines changed

azure-stack/operator/azure-stack-diagnostic-test.md

Lines changed: 32 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
title: Validate system state with the Azure Stack Hub validation tool
33
description: Learn how to use the Azure Stack Hub validation tool to validate system state.
44
author: sethmanheim
5-
ms.date: 01/23/2024
5+
ms.date: 01/28/2025
66
ms.topic: article
77
ms.author: sethm
8-
ms.reviewer: adshar
98
ms.lastreviewed: 01/10/2020
109

1110
# Intent: As an Azure Stack operator, I want to use the Azure Stack validation tool to validate the system state.
@@ -15,7 +14,7 @@ ms.lastreviewed: 01/10/2020
1514

1615
# Validate Azure Stack Hub system state
1716

18-
As an Azure Stack Hub operator, being able to determine the health and status of your system on demand is essential. The [Azure Stack Hub validation tool (**Test-AzureStack**)](../reference/pep/test-azurestack.md)) is a PowerShell cmdlet that lets you run a series of tests on your system to identify failures if present. You'll typically be asked to run this tool through the [privileged end point (PEP)](azure-stack-privileged-endpoint.md) when you contact Microsoft Customer Services Support (Microsoft Support) with an issue. With the system-wide health and status information at hand, Microsoft Support can collect and analyze detailed logs, focus on the area where the error occurred, and work with you to fix the issue.
17+
As an Azure Stack Hub operator, being able to determine the health and status of your system on demand is essential. The [Azure Stack Hub validation tool (**Test-AzureStack**)](../reference/pep/test-azurestack.md) is a PowerShell cmdlet that lets you run a series of tests on your system to identify failures if present. You'll typically be asked to run this tool through the [privileged end point (PEP)](azure-stack-privileged-endpoint.md) when you contact Microsoft Customer Services Support (Microsoft Support) with an issue. With the system-wide health and status information at hand, Microsoft Support can collect and analyze detailed logs, focus on the area where the error occurred, and work with you to fix the issue.
1918

2019
## Running the validation tool and accessing results
2120

@@ -50,17 +49,17 @@ Here's an outline of the end-to-end validation testing process:
5049

5150
1. If any tests report **FAIL**, run `Get-AzureStackLog`. For instructions on an integrated system, see how to run [Get-AzureStackLog on Azure Stack Hub integrated systems](azure-stack-get-azurestacklog.md).
5251

53-
The cmdlet gathers logs generated by Test-AzureStack. We recommend you don't collect logs and contact Microsoft Support instead if tests report **WARN**.
52+
The cmdlet gathers logs generated by **Test-AzureStack**. If the tests report **WARN**, we recommend that you don't collect logs, and instead contact Microsoft Support.
5453

55-
1. If you're instructed to run the validation tool by the Microsoft Support, the Microsoft Support representative will request the logs you collected to continue troubleshooting your issue.
54+
1. If you're instructed to run the validation tool by the Microsoft Support, the Microsoft Support representative requests the logs you collected in order to continue troubleshooting your issue.
5655

5756
## Tests available
5857

59-
The validation tool lets you run a series of system-level tests and basic cloud scenarios that provide you with insight to the current state, allowing you to fix issues in your system.
58+
The validation tool lets you run a series of system-level tests and basic cloud scenarios that provide you with insight into the current state, enabling you to fix issues in your system.
6059

6160
### Cloud infrastructure tests
6261

63-
These low impact tests work on an infrastructure level and provide you with information on various system components and functions. Currently, tests are grouped into the following categories:
62+
These low impact tests work on an infrastructure level and provide you with information about various system components and functions. Currently, tests are grouped into the following categories:
6463

6564
| Test Category | Argument for -Include and -Ignore |
6665
| :--------------------------------------------------- | :-------------------------------- |
@@ -132,7 +131,6 @@ The following cloud scenarios are tested by the validation tool:
132131
## Parameter considerations
133132

134133
- The parameter **List** can be used to display all available test categories.
135-
136134
- The parameters **Include** and **Ignore** can be used to include or exclude test categories. For more information about these arguments, see the following section.
137135

138136
```powershell
@@ -144,21 +142,19 @@ The following cloud scenarios are tested by the validation tool:
144142
```
145143

146144
- A tenant VM is deployed as part of the cloud scenario tests. You can use **DoNotDeployTenantVm** to disable this VM deployment.
147-
148-
- You need to supply the **ServiceAdminCredential** parameter to run cloud scenario tests as described in the [Use case examples](azure-stack-diagnostic-test.md#use-case-examples) section.
149-
145+
- You must supply the **ServiceAdminCredential** parameter to run cloud scenario tests as described in the [Use case examples](azure-stack-diagnostic-test.md#use-case-examples) section.
150146
- **BackupSharePath** and **BackupShareCredential** are used when testing infrastructure backup settings as shown in the [Use case examples](azure-stack-diagnostic-test.md#use-case-examples) section.
151-
152147
- **DetailedResults** can be used to get pass/fail/warning information for each test, as well as the overall run. When not specified, **Test-AzureStack** returns **$true** if there are no failures, and **$false** if there are failures.
153148
- **TimeoutSeconds** can be used to set a specific time for each group to complete.
154-
155149
- The validation tool also supports common PowerShell parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see [About Common Parameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
156150

157151
## Use case examples
158152

153+
The following examples show how to run the validation tool with different parameters and scenarios.
154+
159155
### Run validation without cloud scenarios
160156

161-
Run the validation tool without the **ServiceAdminCredential** parameter to skip running cloud scenario tests:
157+
Run the validation tool without the **ServiceAdminCredential** parameter to skip running cloud scenario tests:
162158

163159
```powershell
164160
New-PSSession -ComputerName "<ERCS VM-name/IP address>" -ConfigurationName PrivilegedEndpoint -Credential $localcred -SessionOption (New-PSSessionOption -Culture en-US -UICulture en-US)
@@ -167,25 +163,25 @@ Test-AzureStack
167163

168164
### Run validation with cloud scenarios
169165

170-
Supplying the validation tool with the **ServiceAdminCredentials** parameter runs the cloud scenario tests by default:
166+
Supplying the validation tool with the **ServiceAdminCredentials** parameter runs the cloud scenario tests by default:
171167

172168
```powershell
173169
Enter-PSSession -ComputerName "<ERCS VM-name/IP address>" -ConfigurationName PrivilegedEndpoint -Credential $localcred
174170
Test-AzureStack -ServiceAdminCredential "<Cloud administrator user name>"
175171
```
176172

177-
If you wish to run ONLY cloud scenarios without running the rest of the tests, you can use the **Include** parameter to do so:
173+
If you only want to run cloud scenarios without running the rest of the tests, you can use the `Include` parameter:
178174

179175
```powershell
180176
Enter-PSSession -ComputerName "<ERCS VM-name/IP address>" -ConfigurationName PrivilegedEndpoint -Credential $localcred
181177
Test-AzureStack -ServiceAdminCredential "<Cloud administrator user name>" -Include AzsScenarios
182178
```
183179

184-
The cloud admin user name must be typed in the UPN format: [email protected] (Microsoft Entra ID). When prompted, type the password to the cloud admin account.
180+
The cloud admin user name must be typed in the UPN format: `[email protected]` (Microsoft Entra ID). When prompted, type the password to the cloud admin account.
185181

186182
### Groups
187183

188-
To improve the operator experience, a **Group** parameter has been enabled to run multiple test categories at the same time. Currently, there are three groups defined: **Default**, **UpdateReadiness**, and **SecretRotationReadiness**.
184+
To improve the operator experience, a **Group** parameter runs multiple test categories at the same time. Currently, there are three groups defined: **Default**, **UpdateReadiness**, and **SecretRotationReadiness**.
189185

190186
- **Default**: Considered to be a standard run of **Test-AzureStack**. This group is run by default if no other groups are selected.
191187
- **UpdateReadiness**: A check to see if the Azure Stack Hub instance can be updated. When the **UpdateReadiness** group is run, warnings are displayed as errors in the console output, and they should be considered as blockers for the update. The following categories are part of the **UpdateReadiness** group:
@@ -216,39 +212,38 @@ Test-AzureStack -Group UpdateReadiness
216212

217213
### Run validation tool to test infrastructure backup settings
218214

219-
*Before* configuring infrastructure backup, you can test the backup share path and credential using the **AzsBackupShareAccessibility** test:
215+
Before configuring infrastructure backup, you can test the backup share path and credential using the **AzsBackupShareAccessibility** test:
220216

221-
```powershell
222-
Enter-PSSession -ComputerName "<ERCS VM-name/IP address>" -ConfigurationName PrivilegedEndpoint -Credential $localcred
223-
Test-AzureStack -Include AzsBackupShareAccessibility -BackupSharePath "\\<fileserver>\<fileshare>" -BackupShareCredential $using:backupcred
224-
```
217+
```powershell
218+
Enter-PSSession -ComputerName "<ERCS VM-name/IP address>" -ConfigurationName PrivilegedEndpoint -Credential $localcred
219+
Test-AzureStack -Include AzsBackupShareAccessibility -BackupSharePath "\\<fileserver>\<fileshare>" -BackupShareCredential $using:backupcred
220+
```
225221

226-
*After* configuring backup, you can run **AzsBackupShareAccessibility** to validate the share is accessible from the ERCS:
222+
After configuring backup, you can run **AzsBackupShareAccessibility** to validate the share is accessible from the ERCS:
227223

228-
```powershell
229-
Enter-PSSession -ComputerName "<ERCS VM-name/IP address>" -ConfigurationName PrivilegedEndpoint -Credential $localcred
230-
Test-AzureStack -Include AzsBackupShareAccessibility
231-
```
224+
```powershell
225+
Enter-PSSession -ComputerName "<ERCS VM-name/IP address>" -ConfigurationName PrivilegedEndpoint -Credential $localcred
226+
Test-AzureStack -Include AzsBackupShareAccessibility
227+
```
232228

233-
To test new credentials with the configured backup share, run:
229+
To test new credentials with the configured backup share, run:
234230

235-
```powershell
236-
Enter-PSSession -ComputerName "<ERCS VM-name/IP address>" -ConfigurationName PrivilegedEndpoint -Credential $localcred
237-
Test-AzureStack -Include AzsBackupShareAccessibility -BackupShareCredential "<PSCredential for backup share>"
238-
```
231+
```powershell
232+
Enter-PSSession -ComputerName "<ERCS VM-name/IP address>" -ConfigurationName PrivilegedEndpoint -Credential $localcred
233+
Test-AzureStack -Include AzsBackupShareAccessibility -BackupShareCredential "<PSCredential for backup share>"
234+
```
239235

240236
### Run validation tool to test network infrastructure
241237

242238
This test checks the connectivity of the network infrastructure bypassing the Azure Stack Hub software defined network (SDN). It demonstrates connectivity from a Public VIP to the configured DNS forwarders, NTP servers, and authentication endpoints. This includes connectivity to Azure when using Microsoft Entra ID as identity provider or the federated server when using AD FS as identity provider.
243239

244-
Include the debug parameter to get a detailed output of the command:
240+
Include the `-Debug` parameter to get a detailed output of the command:
245241

246242
```powershell
247243
Test-AzureStack -Include AzsNetworkInfra -Debug
248244
```
249245

250246
## Next steps
251247

252-
To learn more about Azure Stack Hub diagnostics tools and issue logging, see [Azure Stack Hub Diagnostic log collection](./diagnostic-log-collection.md).
253-
254-
To learn more about troubleshooting, see [Microsoft Azure Stack Hub troubleshooting](azure-stack-troubleshooting.md).
248+
- For more information about Azure Stack Hub diagnostics tools and issue logging, see [Azure Stack Hub Diagnostic log collection](./diagnostic-log-collection.md)
249+
- For more information about troubleshooting, see [Microsoft Azure Stack Hub troubleshooting](azure-stack-troubleshooting.md)

azure-stack/user/user-overview.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
---
22
title: What is Azure Stack Hub for a user?
3-
description: Learn how to use Azure Stack Hub as a developer.
3+
description: Learn how to use Azure Stack Hub as a user.
44
author: sethmanheim
5-
65
ms.topic: article
7-
ms.date: 12/2/2020
6+
ms.date: 01/28/2025
87
ms.author: sethm
98
ms.reviewer: thoroet
109
ms.lastreviewed: 12/2/2020
1110

12-
# Intent: As an Azure Stack Hub user, I wan to learn about how where to find more information developing solutions.
11+
# Intent: As an Azure Stack Hub user, I want to learn about where to find more information about developing solutions.
1312
# Keywords: Develop solutions with Azure Stack Hub
1413

1514
---
@@ -20,9 +19,7 @@ Azure Stack Hub is a hybrid cloud platform that lets you use Azure services from
2019

2120
## How to use Azure Stack Hub
2221

23-
If you're an Azure Stack Hub operator who manages the infrastructure and offers services, check out the [operator documentation](../operator/index.yml).
24-
25-
If you are an Azure Stack Hub user interested in the Azure Stack Development Kit (ASDK), a single-node deployment of Azure Stack Hub that you can download and use for free, see the [ASDK documentation](../asdk/index.yml).
22+
If you're an Azure Stack Hub operator who manages the infrastructure and offers services, see the [operator documentation](../operator/index.yml).
2623

2724
## Next steps
2825

0 commit comments

Comments
 (0)