< Back

Get-AzureOSDisk

Wed Jan 30, 2019 5:44 pm

NAME Get-AzureOSDisk



SYNOPSIS

Gets the operating system disk of an Azure virtual machine.





SYNTAX

Get-AzureOSDisk -VM <IPersistentVM> [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]

[<CommonParameters>]





DESCRIPTION

The Get-AzureOSDisk cmdlet gets the operating system disk of an Azure virtual machine.





PARAMETERS

-VM <IPersistentVM>

Specifies the virtual machine for which this cmdlet gets the operating system disk. To obtain a virtual machine object, use the Get-AzureVM cmdlet.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue, ByPropertyName)

Accept wildcard characters? false



-Profile <AzureSMProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









-------------------------- Example 1: Get an operating system disk --------------------------



PS C:\\>Get-AzureVM -ServiceName "ContosoService" -Name "VirtualMachine02" | Get-AzureOSDisk



This command gets the virtual machine named VirtualMachine02 in the service named ContosoService by using the Get-AzureVM cmdlet. The command passes the

virtual machine to the current cmdlet by using the pipeline operator. The current cmdlet gets the operating system disk of that virtual machine.



RELATED LINKS

Get-AzureDataDisk

Set-AzureOSDisk