Set-AzVMDiagnosticsExtension

Module:

Az.Compute Module

Configures the Azure diagnostics extension on a virtual machine.

Set-AzVMDiagnosticsExtension
 [-ResourceGroupName] <String>
 [-VMName] <String>
 [-DiagnosticsConfigurationPath] <String>
 [[-StorageAccountName] <String>]
 [[-StorageAccountKey] <String>]
 [[-StorageAccountEndpoint] <String>]
 [[-StorageContext] <IStorageContext>]
 [[-Location] <String>]
 [[-Name] <String>]
 [[-TypeHandlerVersion] <String>]
 [[-AutoUpgradeMinorVersion] <Boolean>]
 [-NoWait]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

The Set-AzVMDiagnosticsExtension cmdlet configures the Azure diagnostics extension on a virtual machine.

Set-AzVMDiagnosticsExtension -ResourceGroupName "ResourceGroup01" -VMName "VirtualMachine02" -DiagnosticsConfigurationPath "diagnostics_publicconfig.xml"

This command uses a diagnostics configuration file to enable diagnostics. The file diagnostics_publicconfig.xml contains the public XML configuration for the diagnostics extension including the name of the storage account to which diagnostics data will be sent. The diagnostics storage account must be in the same subscription as the virtual machine.

Set-AzVMDiagnosticsExtension -ResourceGroupName "ResourceGroup1" -VMName "VirtualMachine2" -DiagnosticsConfigurationPath diagnostics_publicconfig.xml -StorageAccountName "MyStorageAccount"

This command uses the storage account name to enable diagnostics. If the diagnostics configuration does not specify a storage account name or if you want to override the diagnostics storage account name specified in the configuration file, use the StorageAccountName parameter. The diagnostics storage account must be in the same subscription as the virtual machine.

Set-AzVMDiagnosticsExtension -ResourceGroupName "ResourceGroup01" -VMName "VirtualMachine02" -DiagnosticsConfigurationPath "diagnostics_publicconfig.xml" -StorageAccountName "MyStorageAccount" -StorageAccountKey $storage_key

This command uses the storage account name and key to enable diagnostics. If the diagnostics storage account is in a different subscription than the virtual machine then enable sending diagnostics data to that storage account by explicitly specifying its name and key.

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