Azure Cmdlet Reference
Updated: July 3, 2014
The Azure Cmdlet Reference provides information about Windows PowerShell modules that help you to automate your Microsoft Azure tasks. This reference includes information about the Windows PowerShell modules for Azure, including system requirements, download links, and configurations tasks. It also includes cmdlet help for the cmdlets and functions in Windows PowerShell modules for Azure.
To learn about the cmdlets in the Azure modules, see these topics:
Azure Service Management Cmdlets (Azure module)
Azure Automation Cmdlets (Azure module)
Azure Cmdlets for Microsoft Antimalware (Azure module)
Azure Active Directory Cmdlets (MSOnline module)
Azure ExpressRoute Cmdlets (ExpressRoute module)
Azure Managed Cache Cmdlets (Azure module)
Azure Profile Cmdlets (AzureProfile module)
Azure Resource Manager Cmdlets (AzureResourceManager module)
Azure Rights Management Cmdlets (AADRM module)
Azure SQL Database Cmdlets (Azure module)
Azure Traffic Manager Cmdlets (Azure Traffic Manager module)
Windows PowerShell modules for Azure are not included in Windows. Before you can use the cmdlets in the modules, you need to download each module and set up your environment so you can connect to Azure from Windows Powershell. For instructions, see the page for each module.
Azure modules are updated frequently. If you notice that the online cmdlet help includes cmdlets or parameters that are not in your module, download and install the latest version of the module. To find the version of your module, type:
For sample scripts that can help you automate some of the common tasks in Azure, see the Windows Azure Script Center.
For general information about installing, learning, using, and customizing Windows PowerShell, see Scripting with Windows PowerShell.
Several of the Azure modules for Windows PowerShell are included in a single installation package known as Azure PowerShell. For information about installing Azure PowerShell, see How to install and configure Windows Azure PowerShell.
Beginning in version 0.8.0, the Azure PowerShell installation includes three Windows PowerShell modules:
Azure: Includes the traditional cmdlets for managing individual resources, such as storage accounts, web sites, databases, virtual machines, and media services. For information about the cmdlets in the Azure module, see Azure Service Management Cmdlets.
AzureResourceManager: Includes cmdlets for creating, managing, and deploying the Azure resources for a complex service as a logical unit. Use this module to create resource groups that support web portals, photo galleries, blogs, wikis and more. For information about the cmdlets in the AzureResourceManager module, see Azure Resource Manage Cmdlets.
AzureProfile: Includes cmdlets common to both modules, such as Add-AzureAccount, Get-AzureSubscription, and Switch-AzureMode. For information about the cmdlets in the AzureProfile module, see Azure Profile Cmdlets.
|The Azure Resource Manager module is currently in preview. It might not provide the same management capabilities as the Azure module.|
The Azure and Azure Resource Management modules are not designed to be used in the same Windows PowerShell session. To make it easy to switch between them, we have added a new cmdlet, Switch-AzureMode.
When you use Azure PowerShell, the cmdlets in the Azure module are imported by default. To switch to the AzureResourceManager module, use the Switch-AzureMode cmdlet. It removes the Azure module from your session and imports the Azure Resource Manager and Azure Profile modules.
PS C:\> Switch-AzureMode -Name AzureResourceManager
To switch to the Azure module, use the Switch-AzureMode cmdlet again.
PS C:\> Switch-AzureMode -Name AzureServiceManagement
For help with the Switch-AzureMode cmdlet, type:
Get-Help Switch-AzureMode or see Switch-AzureModule.