Skip to content

Commit 9a165ff

Browse files
committed
Updated text per PM feedback
1 parent 443f874 commit 9a165ff

File tree

1 file changed

+4
-115
lines changed

1 file changed

+4
-115
lines changed

azure-local/manage/disconnected-operations-fallback.md

Lines changed: 4 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,10 @@ Import-Module "C:\azurelocal\OperationsModule\ApplianceFallbackLogging.psm1" -Fo
3434

3535
## Export logs for the fallback scenario
3636

37-
To export logs for the fallback scenario, use three cmdlets:
37+
To export logs for the fallback scenario, use these cmdlets:
3838

3939
- [**Copy-DiagnosticData**](#copy-diagnosticdata)
4040
- [**Send-DiagnosticData**](#send-diagnosticdata)
41-
- [**Get-ObservabilityStampId**](#get-observabilitystampid-optional)
4241

4342
### Copy-DiagnosticData
4443

@@ -252,119 +251,9 @@ Here's an example of the file structure for the send logs:
252251

253252
The send logs file structure has all the logs and installation files from the standalone observability pipeline, including the **GMACache logs** and pipeline install and uninstall logs.
254253

255-
### Get-ObservabilityStampId (optional)
256-
257-
> [!NOTE]
258-
> You don't need to use this cmdlet with `Copy-DiagnosticData`.
259-
260-
The `Get-ObservabilityStampId` cmdlet is a heavy operation and is only needed in rare cases. This cmdlet also shuts down the Azure Local VM running disconnected and mounts the OS volume VHD to get the stamp ID. After the operation, the Azure Local VM running disconnected restarts.
261-
262-
Use these parameters with the `Get-ObservabilityStampId` cmdlet:
263-
264-
- **MountPath**: Optional. A valid drive or path to temporarily hold mounted VHDs used to retrieve the stamp ID. The file is removed on cleanup at the end of the cmdlet.
265-
- **Recoverykeyset**: Optional. The RecoveryKeySet containing relevant **ProtectorId** and **RecoveryPassword** pairs for BitLocker encrypted volumes used for log collection retrieval. If recovery keys aren't provided, manual entry of the keys is required during the mount process.
266-
267-
> [!TIP]
268-
> You can provide a desired path for the mounted VHD. Otherwise, the default path `${env:USERPROFILE}\MountedVHDs` is used.
269-
270-
Here's an example of the output with a custom path:
271-
272-
```powershell
273-
Get-ObservabilityStampId -MountPath "C:/temp/path"
274-
```
275-
276-
```console
277-
StampId
278-
-------
279-
<Stamp Id>
280-
```
281-
282-
If the command doesn't return a `StampId`, the stamp ID isn't set and you need to pass it into [Send-DiagnosticData](#send-diagnosticdata) manually. If the stamp ID isn't set and you don't pass it manually, it defaults to the host **UUID**.
283-
284-
Alternatively, you can use the `Get-ApplianceInstanceConfiguration` command to get the stamp ID.
285-
286-
```powershell
287-
$stampId = (Get-ApplianceInstanceConfiguration).StampId
288-
```
289-
290-
## Appendix
291-
292-
To view detailed information about each cmdlet, use these commands:
293-
294-
<details>
295-
296-
<summary>Get-Help Copy-DiagnosticData -Detailed</summary>
297-
298-
```plaintext
299-
EXAMPLE 1
300-
PS C:\> Copy-DiagnosticData -DiagnosticLogPath "C:"
301-
302-
EXAMPLE 2
303-
PS C:\>Copy-DiagnosticData -DiagnosticLogPath "C:/path/to/copied_logs_parent_directory"
304-
305-
EXAMPLE 3
306-
PS C:\>Copy-DiagnosticData -DiagnosticLogPath "C:" -Roles @("Agents", "Oplets", "ServiceFabric")
307-
308-
EXAMPLE 4
309-
PS C:\>$fromDate = [datetime]"03/13/2024 12:00:00"
310-
$toDate = [datetime]"03/13/2024 15:00:00"
311-
Copy-DiagnosticData -DiagnosticLogPath "C:" -FromDate
312-
$fromDate -ToDate $toDate
313-
```
314-
315-
</details>
316-
317-
<details>
318-
319-
<summary>Get-Help Get-ObservabilityStampId -Detailed</summary>
320-
321-
```plaintext
322-
EXAMPLE 1
323-
PS C:\>Get-ObservabilityStampId
324-
325-
EXAMPLE 2
326-
PS C:\>Get-ObservabilityStampId -MountPath "C:/temp/path”
327-
```
328-
329-
</details>
330-
331-
<details>
332-
333-
<summary>Get-Help Send-DiagnosticData -Detailed</summary>
334-
335-
```plaintext
336-
EXAMPLE 1
337-
PS C:\># Interactive registration with device code (used by default)
338-
339-
Send-DiagnosticData -ResourceGroupName "Resource group" ` -SubscriptionId "Subscription Id" ` -TenantId "Tenant Id" ` -RegistrationRegion "eastus" ` -DiagnosticLogPath "C:\path\to\LogsToExport" ` -StampId "Stamp ID"
340-
341-
EXAMPLE 2
342-
PS C:\># Interactive registration with device code (declared explicitly)
343-
344-
Send-DiagnosticData -ResourceGroupName "Resource group" `
345-
-SubscriptionId "Subscription Id" ` -TenantId "Tenant Id" ` -RegistrationWithDeviceCode ` -RegistrationRegion "eastus" ` -DiagnosticLogPath "C:\path\to\LogsToExport" ` -StampId "Stamp ID"
346-
347-
EXAMPLE 3
348-
PS C:\># Registration with Service Principal Credential
349-
350-
Send-DiagnosticData -ResourceGroupName "Resource group" ` -SubscriptionId "Subscription Id" ` -TenantId "Tenant Id" ` -RegistrationWithCredential {$credential} ` -RegistrationRegion "eastus" ` -DiagnosticLogPath "C:\path\to\LogsToExport" ` -StampId "Stamp ID"
351-
352-
EXAMPLE 4
353-
PS C:\># Get-ObservabilityStampId pipes the Observability Id as the 'StampId' if available.
354-
355-
Get-ObservabilityStampId | Send-DiagnosticData ` -ResourceGroupName "Resource group" ` -SubscriptionId "Subscription Id" ` -TenantId "Tenant Id" ` -RegstrationRegion “eastus” ` -DiagnosticLogPath "C:\path\to\LogsToExport"
356-
357-
EXAMPLE 5
358-
PS C:\># Copy-DiagnosticData pipes the 'DiagnosticLogPath' (always) and the Observability Id
359-
# as the 'StampId' if available.
360-
361-
Copy-DiagnosticData -DiagnosticLogPath "C:" -Roles @("ServiceFabric") ` | Send-DiagnosticData -ResourceGroupName "Resource group" ` -SubscriptionId "Subscription Id" ` -TenantId "Tenant Id" ` -RegstrationRegion “eastus”
362-
363-
EXAMPLE 6
364-
PS C:\> $roles = @("Agents", "Oplets", "MASLogs")
365-
366-
PS C:\> Copy-DiagnosticData -DiagnosticLogPath "G:" -Roles $roles ` | Send-DiagnosticData ` -ResourceGroupName "Resource group" ` -RegistrationRegion "eastus" ` -SubscriptionId "Subscription Id" ` -TenantId "Tentant Id" ` -RegistrationWithCredential $sp
367-
```
254+
## Related content
255+
- [Collect logs on-demand with Azure Local disconnected operations (preview)](disconnected-operations-on-demand-logs.md)
256+
- [Disconnected operations with Azure Local Overview](disconnected-operations-overview.md)
368257

369258
</details>
370259

0 commit comments

Comments
 (0)