Skip to content

Commit 5ed022f

Browse files
committed
Fixed warnings in on demand logs article
1 parent 160d443 commit 5ed022f

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

azure-local/manage/disconnected-operations-on-demand-logs.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ The following on-demand scenarios are supported for log collection:
2929

3030
| Scenarios for log collection | How to collect logs |
3131
|------------------------------------------|----------------------------------------|
32-
| [Use on-demand direct log collection](#log-collection-for-a-disconnected-environment-with-an-accessible-management-endpoint) when an on-premises device with Azure Local disconnected operations is connected to Azure and the management endpoint for disconnected operations is accessible. | Trigger log collection with the `Invoke-ApplianceLogCollection` cmdlet. |
33-
| [Use on-demand indirect log collection](#log-collection-for-control-plane-when-connected-to-azure-with-an-accessible-management-endpoint) when an on-premises device using Azure Local disconnected operations doesn't have a connection to Azure, but the management endpoint for disconnected operations is accessible. | Trigger log collection with the `Invoke-ApplianceLogCollectionAndSaveToShareFolder` cmdlet.<br></br> After you run the `Invoke-ApplianceLogCollectionAndSaveToShareFolder` cmdlet, use the `Send-DiagnosticData` cmdlet to upload the copied data logs from the file share to Microsoft. |
34-
| [Use on-demand fallback log collection](#log-collection-when-the-management-endpoint-is-inaccessible) when the management endpoint for disconnected operations isn't accessible or the integrated runtime disconnected operations with Azure Local virtual machine (VM) is down. | Collect logs after you shut down the disconnected operations appliance VM, mount and unlock virtual hard disks (VHDs), and copy logs by using the `Copy-DiagnosticData` cmdlet from mounted VHDs into a local, user-defined location.<br></br> Use the `Send-DiagnosticData` cmdlet to manually send diagnostic data to Microsoft. |
32+
| [Use on-demand direct log collection](#collect-logs-on-demand-with-the-azure-local-disconnected-operations-powershell-module) when an on-premises device with Azure Local disconnected operations is connected to Azure and the management endpoint for disconnected operations is accessible. | Trigger log collection with the `Invoke-ApplianceLogCollection` cmdlet. |
33+
| [Use on-demand indirect log collection](#azure-local-disconnected-when-the-appliance-vm-isnt-connected-to-azure) when an on-premises device using Azure Local disconnected operations doesn't have a connection to Azure, but the management endpoint for disconnected operations is accessible. | Trigger log collection with the `Invoke-ApplianceLogCollectionAndSaveToShareFolder` cmdlet.<br></br> After you run the `Invoke-ApplianceLogCollectionAndSaveToShareFolder` cmdlet, use the `Send-DiagnosticData` cmdlet to upload the copied data logs from the file share to Microsoft. |
34+
| [Use on-demand fallback log collection](#indirect-or-fallback-log-collection-disconnected-mode) when the management endpoint for disconnected operations isn't accessible or the integrated runtime disconnected operations with Azure Local virtual machine (VM) is down. | Collect logs after you shut down the disconnected operations appliance VM, mount and unlock virtual hard disks (VHDs), and copy logs by using the `Copy-DiagnosticData` cmdlet from mounted VHDs into a local, user-defined location.<br></br> Use the `Send-DiagnosticData` cmdlet to manually send diagnostic data to Microsoft. |
3535

3636
## Azure Local disconnected when the appliance VM isn't connected to Azure
3737

@@ -201,38 +201,42 @@ Intended for use in cases where direct log collection from appliance VM is unava
201201
### Syntax
202202

203203
This option triggers a manual login via device code for permissions:
204-
Send-DiagnosticData -ResourceGroupName <String> -SubscriptionId <String> -TenantId <String> [-RegistrationWithDeviceCode] -RegistrationRegion <String> [-Cloud <String>] -DiagnosticLogPath <String> [-ObsRootFolderPath <String>] [-StampId <Guid>]
205-
[<CommonParameters>]
204+
205+
```
206+
Send-DiagnosticData -ResourceGroupName <String> -SubscriptionId <String> -TenantId <String> [-RegistrationWithDeviceCode] -RegistrationRegion <String> [-Cloud <String>] -DiagnosticLogPath <String> [-ObsRootFolderPath <String>] [-StampId <Guid>] [<CommonParameters>]
207+
```
206208

207209
This option uses service principal credentials:
208-
Send-DiagnosticData -ResourceGroupName <String> -SubscriptionId <String> -TenantId <String> -RegistrationWithCredential <PSCredential> -RegistrationRegion <String> [-Cloud <String>] -DiagnosticLogPath <String> [-ObsRootFolderPath <String>] [-StampId <Guid>]
209-
[<CommonParameters>]
210+
211+
```
212+
Send-DiagnosticData -ResourceGroupName <String> -SubscriptionId <String> -TenantId <String> -RegistrationWithCredential <PSCredential> -RegistrationRegion <String> [-Cloud <String>] -DiagnosticLogPath <String> [-ObsRootFolderPath <String>] [-StampId <Guid>] [<CommonParameters>]
213+
```
210214

211215
### Parameters
212216

213-
- ResourceGroupName <String>
217+
- ResourceGroupName `<String>`
214218
- Azure Resource group name where temporary Arc resource will be created.
215219

216-
- SubscriptionId <String>
220+
- SubscriptionId `<String>`
217221
- Azure SubscriptionID where temporary Arc resource will be created.
218222

219-
- TenantId <String>
223+
- TenantId `<String>`
220224
- Azure TenantID where temporary Arc resource will be created.
221225

222-
- RegistrationWithDeviceCode [<SwitchParameter>]
226+
- RegistrationWithDeviceCode `[<SwitchParameter>]`
223227
- Switch to use device code for authentication. This is the default if Service Principal credentials (-RegistrationWithCredential {creds}) is not provided.
224-
- RegistrationWithCredential <PSCredential>
228+
- RegistrationWithCredential `<PSCredential>`
225229
- Service Principal credentials used for authentication to register ArcAgent.
226-
- RegistrationRegion <String>
230+
- RegistrationRegion `<String>`
227231
- Azure registration region where Arc resource will be created, e.g. 'eastus' or 'westeurope'.
228-
- Cloud <String>
229-
Optional. Default: AzureCloud
230-
- DiagnosticLogPath <String>
231-
Path to a directory containing the logs to be parsed and sent to Microsoft.
232-
- ObsRootFolderPath <String>
233-
- Optional. Observability root folder path where the standalone pipeline is (temporarily) installed and activity logs related to sending diagnostic data are output.
232+
- Cloud `<String>`
233+
- Optional. Default: AzureCloud
234+
- DiagnosticLogPath `<String>`
235+
- Path to a directory containing the logs to be parsed and sent to Microsoft.
236+
- ObsRootFolderPath `<String>`
237+
- Optional. Observability root folder path where the standalone pipeline is (temporarily) installed and activity logs related to sending diagnostic data are output.
234238
- Default: {DiagnosticLogPath}\..\SendLogs_{yyyyMMddTHHmmssffff} (a new file created in the DiagnosticLogPath parent directory)
235-
- StampId <Guid>
239+
- StampId `<Guid>`
236240
- Optional. Unique id for disconnected operations deployment. This GUID is used for tracking collected logs on Microsoft support. Same can be retrieved using Get-ApplianceInstanceConfiguration when management endpoint is accessible for disconnected operations appliance VM. The default value applied will be based on the following setting:
237241
- Provided StampId GUID
238242
- $env:STAMP_GUID (when StampId GUID not provided)

0 commit comments

Comments
 (0)