You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: azure-stack/operator/azure-stack-diagnostic-test.md
+32-37Lines changed: 32 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,9 @@
2
2
title: Validate system state with the Azure Stack Hub validation tool
3
3
description: Learn how to use the Azure Stack Hub validation tool to validate system state.
4
4
author: sethmanheim
5
-
ms.date: 01/23/2024
5
+
ms.date: 01/28/2025
6
6
ms.topic: article
7
7
ms.author: sethm
8
-
ms.reviewer: adshar
9
8
ms.lastreviewed: 01/10/2020
10
9
11
10
# 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
15
14
16
15
# Validate Azure Stack Hub system state
17
16
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.
19
18
20
19
## Running the validation tool and accessing results
21
20
@@ -50,17 +49,17 @@ Here's an outline of the end-to-end validation testing process:
50
49
51
50
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).
52
51
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.
54
53
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.
56
55
57
56
## Tests available
58
57
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.
60
59
61
60
### Cloud infrastructure tests
62
61
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:
64
63
65
64
| Test Category | Argument for -Include and -Ignore |
@@ -132,7 +131,6 @@ The following cloud scenarios are tested by the validation tool:
132
131
## Parameter considerations
133
132
134
133
- The parameter **List** can be used to display all available test categories.
135
-
136
134
- The parameters **Include** and **Ignore** can be used to include or exclude test categories. For more information about these arguments, see the following section.
137
135
138
136
```powershell
@@ -144,21 +142,19 @@ The following cloud scenarios are tested by the validation tool:
144
142
```
145
143
146
144
- 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.
150
146
-**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
-
152
147
-**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.
153
148
-**TimeoutSeconds** can be used to set a specific time for each group to complete.
154
-
155
149
- 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).
156
150
157
151
## Use case examples
158
152
153
+
The following examples show how to run the validation tool with different parameters and scenarios.
154
+
159
155
### Run validation without cloud scenarios
160
156
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:
Test-AzureStack -ServiceAdminCredential "<Cloud administrator user name>" -Include AzsScenarios
182
178
```
183
179
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.
185
181
186
182
### Groups
187
183
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**.
189
185
190
186
-**Default**: Considered to be a standard run of **Test-AzureStack**. This group is run by default if no other groups are selected.
191
187
-**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:
Test-AzureStack -Include AzsBackupShareAccessibility -BackupShareCredential "<PSCredential for backup share>"
234
+
```
239
235
240
236
### Run validation tool to test network infrastructure
241
237
242
238
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.
243
239
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:
245
241
246
242
```powershell
247
243
Test-AzureStack -Include AzsNetworkInfra -Debug
248
244
```
249
245
250
246
## Next steps
251
247
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)
Copy file name to clipboardExpand all lines: azure-stack/user/user-overview.md
+4-7Lines changed: 4 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,14 @@
1
1
---
2
2
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.
4
4
author: sethmanheim
5
-
6
5
ms.topic: article
7
-
ms.date: 12/2/2020
6
+
ms.date: 01/28/2025
8
7
ms.author: sethm
9
8
ms.reviewer: thoroet
10
9
ms.lastreviewed: 12/2/2020
11
10
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.
13
12
# Keywords: Develop solutions with Azure Stack Hub
14
13
15
14
---
@@ -20,9 +19,7 @@ Azure Stack Hub is a hybrid cloud platform that lets you use Azure services from
20
19
21
20
## How to use Azure Stack Hub
22
21
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).
0 commit comments