Skip to content

Latest commit

 

History

History
170 lines (132 loc) · 3.52 KB

Enable-AvdDiagnostics.md

File metadata and controls

170 lines (132 loc) · 3.52 KB
external help file Module Name online version schema
Az.Avd-help.xml
Az.Avd
2.0.0

Enable-AvdDiagnostics

SYNOPSIS

Enables the AVD Diagnostics and will send it to a new LogAnalytics workspace

SYNTAX

Existing (Default)

Enable-AvdDiagnostics [-HostpoolName <String>] [-ResourceGroupName <String>] [-LAWorkspace <String>]
 [-LaResourceGroupName <String>] [-Categories <Array>] [<CommonParameters>]

Initial

Enable-AvdDiagnostics [-HostpoolName <String>] [-ResourceGroupName <String>] [-LAWorkspace <String>]
 [-LASku <String>] [-LaResourceGroupName <String>] [-diagnosticsName <String>] [-Categories <Array>]
 [-RetentionInDays <Int32>] [<CommonParameters>]

DESCRIPTION

The function will enable AVD diagnostics for a hostpool. It will create a new Log Analytics workspace if no existing workspace is provided.

EXAMPLES

EXAMPLE 1

Enable-AvdDiagnostics -HostPoolName avd-hostpool-001 -ResourceGroupName rg-avd-001 -LAWorkspace 'la-avd-workspace' -Categories ("Checkpoint","Error")

PARAMETERS

-HostpoolName

Enter the name of the hostpool you want to enable start vm on connnect.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceGroupName

Enter the name of the resourcegroup where the hostpool resides in.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LAWorkspace

Enter the name of the Log Analytics Workspace

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LASku

Enter the name of the Log Analytics SKU

Type: String
Parameter Sets: Initial
Aliases:

Required: False
Position: Named
Default value: Standard
Accept pipeline input: False
Accept wildcard characters: False

-LaResourceGroupName

Enter the name of the Log Analyics Workspace resource group

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-diagnosticsName

The diagnostics name shown in the hostpool diagnostics overview

Type: String
Parameter Sets: Initial
Aliases:

Required: False
Position: Named
Default value: AVD-Diagnostics
Accept pipeline input: False
Accept wildcard characters: False

-Categories

The categories you like to save in Log Analytics

Type: Array
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RetentionInDays

How long should the data be saved

Type: Int32
Parameter Sets: Initial
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS