Skip to content

Latest commit

 

History

History
130 lines (75 loc) · 6.61 KB

powershell-install-configure.md

File metadata and controls

130 lines (75 loc) · 6.61 KB
Raw

How to install and configure Azure PowerShell#

##What is Azure PowerShell?# Azure PowerShell is a module that provides cmdlets to manage Azure with Windows PowerShell. You can use the cmdlets to create, test, deploy, and manage solutions and services delivered through the Azure platform. In most cases, the cmdlets can be used for the same tasks as the Azure Management Portal, such as creating and configuring cloud services, virtual machines, virtual networks, and web apps.

The module and the source code are available for download on a publicly available repository:

Step 1: Install

Download and install PowerShell 1.0.1

Step 2: Start

The module installs a customized console for Azure PowerShell. You can run the cmdlets from the standard Windows PowerShell console, or from the Azure PowerShell console.

Step 3: Connect

The cmdlets need your subscription so they can manage your services. You can purchase an Azure subscription if you don't already have one. For instructions, see How to buy Azure.

  1. Type Add-AzureAccount

  2. Type the email address and password associated with your account. Azure authenticates and saves the credential information, and then closes the window.

--OR--

Sign into your work or school account:

    $cred = Get-Credential
    Add-AzureAccount -Credential $cred

[AZURE.NOTE] This non-interactive login method only works with a work or school account. A work or school account is a user that is managed by your work or school, and defined in the Azure Active Directory instance for your work or school. If you do not currently have a work or school account, and are using a Microsoft account to log in to your Azure subscription, you can easily create one using the following steps.

  1. Login to the Azure Management Portal, and click on Active Directory.
  1. If no directory exists, select Create your directory and provide the requested information.
  1. Select your directory and add a new user. This new user can sign in using a work or school account. During the creation of the user, you will be supplied with both an e-mail address for the user and a temporary password. Save this information, as it is used in step 5 below.
  1. From the management portal, select Settings and then select Administrators. Select Add, and add the new user as a co-administrator. This allows the work or school account to manage your Azure subscription.
  1. Finally, log out of the Azure portal and then log back in using the work or school account. If this is the first time logging in with this account, you will be prompted to change the password.

For more information on signing up for Microsoft Azure with a work or school account, see Sign up for Microsoft Azure as an Organization.

View account and subscription details

You can have multiple accounts and subscriptions available for use by Azure PowerShell. You can add multiple accounts by running Add-AzureAccount more than once.

To display the available Azure accounts, type Get-AzureAccount.

To display your Azure subscriptions, type Get-AzureSubscription.

Step 4: Test

After you've installed the module and configured your computer to connect to your subscription, you can create an Azure web app to make sure everything is working.

  1. Start the Azure PowerShell console.

  2. Choose a name for your web app. Pick a name that conforms to DNS naming conventions. Valid names can contain only letters 'a' through 'z', numbers '0' through '9', and a hyphen ('-').

    The web app name must be unique in Azure. We'll use "mySite" in this example, but be sure to choose a different name, such as your account name followed by a number.

    After you pick a name, type a command similar to the following. Substitute your web app name for "mySite".

     New-AzureWebsite mySite

    The cmdlet creates the web app and returns an object that represents the new web app. The object properties include useful information about the web app.

  3. To get information about the web app, type this command. It returns a bit of information about all web apps in the subscription, including the one that you just created.

     Get-AzureWebsite

  4. To get more information about your web app, include the web app name in the command. Be sure to substitute the name of your web app for "mySite".

     Get-AzureWebsite -Name mySite

  5. Web apps are started after they are created. To stop the web app, type this command, including the name of your web app.

     Stop-AzureWebsite -Name mySite

  6. To verify that the site's state is 'stopped', run the Get-AzureWebsite command again.

     Get-AzureWebsite

  7. To complete this test, delete the web app. Type:

     Remove-AzureWebsite -Name mySite

  8. To complete the task, confirm that the web app is deleted.

     Get-AzureWebsite -Name mySite

##Getting help##

These resources provide help for specific cmdlets:

  • From within the console, you can use the built-in Help system. The Get-Help cmdlet provides access to this system.

  • Reference information about the cmdlets in the Azure PowerShell modules is also available in the Azure library. For information, see Azure Cmdlet Reference.

For help from the community, try these popular forums: