Skip to content

Commit e7f170f

Browse files
stankovskistankovski
committed
Merge pull request #318 from matt-gibbs/readme
Readme
2 parents 09581f4 + 85f6ab5 commit e7f170f

File tree

1 file changed

+45
-209
lines changed

1 file changed

+45
-209
lines changed

‎README.md

Lines changed: 45 additions & 209 deletions
Original file line numberDiff line numberDiff line change
@@ -1,199 +1,63 @@
11
# Microsoft Azure PowerShell
22

3-
This repository contains a set of PowerShell cmdlets for developers and administrators to develop, deploy and manage Microsoft Azure applications.
4-
5-
* For documentation on how to build and deploy applications to Microsoft Azure please see the [Microsoft Azure Documentation Center](http://azure.microsoft.com/en-us/documentation/).
6-
* For comprehensive documentation on the developer cmdlets see [How to install and configure Azure PowerShell](http://azure.microsoft.com/en-us/documentation/articles/install-configure-powershell/).
7-
* For comprehensive documentation on the full set of Microsoft Azure cmdlets see [Microsoft Azure Management Center](http://go.microsoft.com/fwlink/?linkID=254459&clcid=0x409).
8-
9-
## Features
10-
11-
* Account
12-
* Get and import Azure publish settings
13-
* Login with Microsoft account or Organizational account through Microsoft Azure Active Directory
14-
* Environment
15-
* Get the different out-of-box Microsoft Azure environments
16-
* Add/Set/Remove customized environments (like your Windows Azure Pack environments)
17-
* Get Azure publish settings for a particular environment
18-
* Subscription
19-
* Manage Azure subscription
20-
* Manage AffinityGroup
21-
* Website
22-
* Manage website, such as CRUD, start and stop.
23-
* Manage slot
24-
* Manage WebJob
25-
* Deploy project via WebDeploy
26-
* Diagnostics
27-
* Configure site and application diagnostics
28-
* Log streaming
29-
* Save log
30-
* Cloud Services
31-
* Create scaffolding for cloud service and role. Role support includes Node.js, PHP, Django and Cache.
32-
* Manage cloud service and role, such as CRUD, start and stop.
33-
* Manage extension
34-
* Start/Stop Azure emulator.
35-
* Manage certificate.
36-
* Manage cloud service extensions
37-
* Remote desktop
38-
* Diagnostics
39-
* Microsoft Antimalware
40-
* Windows Azure Diagnostics
41-
* Storage
42-
* Manage storage account and access key.
43-
* Manage storage container and blob, with paging.
44-
* Copy storage blob.
45-
* Manage storage table.
46-
* Manage storage queue.
47-
* Create SAS token.
48-
* Manage metrics and logging.
49-
* Configure timeout
50-
* SQL Database
51-
* CRUD support for database server, database and firewall rule.
52-
* Get database server quota.
53-
* Get/Set database server service objective.
54-
* Manage database copies and active geo-replication.
55-
* Get dropped databases that can be restored.
56-
* Issue requests to restore a live or dropped database to a point in time.
57-
* Issue requests to recover a database from an unavailable database server.
58-
* Manage database and database server auditing policy.
59-
* Service Bus
60-
* Manage service bus namespaces.
61-
* VM
62-
* Manage VM, such as CRUD, import/export and start/stop/restart.
63-
* Manage VM image and VM image disks.
64-
* Manage disk, such as CRUD.
65-
* Manage VM endpoint, such as CRUD and ACL.
66-
* Get/Set VM sub net.
67-
* Manage certificate and SSH key.
68-
* PowerShell remoting
69-
* Manage extension
70-
* BG Info
71-
* Puppet
72-
* Custom Script
73-
* Access
74-
* Microsoft Antimalware
75-
* PowerShell DSC
76-
* Windows Azure Diagnostics
77-
* Public IP, reserved IP and internal load balancer
78-
* Deployment
79-
* Manage deployment, such as CRUD, move, upgrade and restore.
80-
* Get/Create DNS settings of a deployment.
81-
* VNet
82-
* Manage virtual network config, connection and gateway.
83-
* Manage static IP
84-
* Azure Media Services
85-
* Create, read and delete Media Services Accounts
86-
* Generate new account keys for Media Services Accounts
87-
* HDInsight
88-
* Manage clusters, such as CRUD, add/set storage
89-
* Manage jobs, such as CRUD, start/stop/wait/invoke
90-
* Manage HTTP service access. such as grant/revoke
91-
* Store
92-
* View available Microsoft Azure Store Add-On plans.
93-
* Purchase, view, upgrade and remove Microsoft Azure Store Add-On instances.
94-
* Utility
95-
* Test whether a name is available. Currently support cloud service name, storage account name and service bus namespace name.
96-
* Get the list of geo locations supported by Azure.
97-
* Get the list of OS supported by Azure.
98-
* Direct you to Azure portal.
99-
* Windows Azure Pack
100-
* Web Site: CRUD web site, deployment, configure and get log, start/stop/restart/show web site
101-
* Service Bus: CRD namespace
102-
* VM: CRUD VM, get OS disk, size profile and VM template, start/stop/restart/suspend/resume VM
103-
* VNET: CRUD VNET and subnet.
104-
* Cloud Service: CRUD cloud service.
105-
* ExpressRoute
106-
* Manage dedicated circuit
107-
* Manage BGP peering
108-
* Scheduler
109-
* Manage job collections
110-
* Manage HTTP and storage queue jobs
111-
* Resource Manager
112-
* Manage resource groups and deployments
113-
* Query and download gallery templates
114-
* Manage individual resources
115-
* Traffic Manager
116-
* Manage profiles and endpoints
117-
* Azure Automation
118-
* Manage automation accounts
119-
* Manage automation jobs, runbooks and schedules
120-
121-
For detail descriptions and examples of the cmdlets, type
122-
* ```help azure``` to get all the cmdlets.
123-
* ```help node-dev``` to get all Node.js development related cmdlets.
124-
* ```help php-dev``` to get all PHP development related cmdlets.
125-
* ```help python-dev``` to get all Python development related cmdlets.
3+
PowerShell cmdlets for developers and administrators to provision, manage and deploy infrastructure and applications in Azure.
4+
5+
* For more information on Azure services, see the [Microsoft Azure Documentation Center](http://azure.microsoft.com/en-us/documentation/).
6+
* To get started, see [How to install and configure Azure PowerShell](http://azure.microsoft.com/en-us/documentation/articles/install-configure-powershell/).
7+
* For documentation on individual cmdlets see [Microsoft Azure Powershell](http://go.microsoft.com/fwlink/?linkID=254459&clcid=0x409).
8+
9+
## Help
10+
11+
Get help and examples from inside Azure Powershell:
12+
* ```help azure``` to list all the Azure cmdlets.
12613
* ```help <cmdlet name>``` to get the details of a specific cmdlet.
12714

128-
## Supported Environments
15+
## Supported Azure Environments
12916

13017
* [Microsoft Azure](http://www.azure.microsoft.com)
13118
* [Windows Azure Pack](http://www.microsoft.com/en-us/server-cloud/windows-azure-pack.aspx)
13219
* [Microsoft Azure China](http://www.windowsazure.cn/)
13320

134-
## Installation
135-
136-
### Microsoft Web Platform Installer
137-
138-
1. Install [Microsoft Web Platform Installer](http://www.microsoft.com/web/downloads/platform.aspx).
139-
2. Open Microsoft Web Platform Installer and search for __Microsoft Azure PowerShell__.
140-
3. Install.
141-
142-
You can also find the standalone installers for all the versions at [Downloads](https://github.com/Azure/azure-powershell/releases)
143-
144-
### Source Code
145-
146-
1. Download the source code from GitHub repo
147-
2. Follow the [Microsoft Azure PowerShell Developer Guide](https://github.com/Azure/azure-powershell/wiki/Microsoft-Azure-PowerShell-Developer-Guide)
21+
## Install Released Builds
22+
Install using the the [Microsoft Web Platform Installer](http://go.microsoft.com/?linkid=9811175&clcid=0x409).
14823

149-
### Supported PowerShell Versions
24+
Or use a standalone MSI from the latest [Microsoft Azure Powershell releases](https://github.com/Azure/azure-powershell/releases)
15025

151-
* 0.6.9 or lower
152-
* [Windows PowerShell 2.0](http://technet.microsoft.com/en-us/scriptcenter/dd742419)
153-
* [Windows PowerShell 3.0](http://www.microsoft.com/en-us/download/details.aspx?id=34595)
154-
* 0.6.10 to higher
155-
* [Windows PowerShell 3.0](http://www.microsoft.com/en-us/download/details.aspx?id=34595)
26+
## Build Your Own
15627

157-
## Get Started
28+
Fork and clone the repo, and follow the [Microsoft Azure PowerShell Developer Guide](https://github.com/Azure/azure-powershell/wiki/Microsoft-Azure-PowerShell-Developer-Guide)
15829

159-
In general, following are the steps to start using Microsoft Azure PowerShell
30+
## Get Started Using Azure PowerShell
16031

161-
* Get yourself authenticated with Microsoft Azure. For details, please check out [this article](http://azure.microsoft.com/en-us/documentation/articles/install-configure-powershell/).
162-
* Option 1: Login with your Microsoft account or Organizational account directly from PowerShell. Microsoft Azure Active Directory authentication is used in this case. No management certificate is needed.
163-
* Starting from 0.8.6, you can use ``Add-AzureAccount -Credential`` to avoid the browser pop up for Organizational account.
164-
* Option 2: Download and import a publish settings file which contains a management certificate.
165-
* Use the cmdlets
32+
You must be authenticated to manage your Azure subscription with the Azure PowerShell cmdlets. For details, refer to [How to Install and Configure Azure PowerShell](http://azure.microsoft.com/en-us/documentation/articles/install-configure-powershell/).
33+
* Option 1: Login with your Microsoft account or Organizational account directly from PowerShell. No management certificate is required. Microsoft Azure Active Directory authentication is used.
34+
* Option 2: Download and import a publish settings file which contains a management certificate.
16635

167-
The first step can be different for different environment you are targeting. Following are detail instructions for each supported environment.
36+
Authentication setup varies by environment. Details for each environment below.
16837

16938
### Microsoft Azure
170-
171-
If you use both mechanisms on the same subscription, Microsoft Azure Active Directory authentication always wins. If you want to go back to management certificate authentication, please use ``Remove-AzureAccount``, which will remove the Microsoft Azure Active Directory information and bring management certificate authentication back in.
39+
If you configure both a credential and management certificate, the Microsoft Azure Active Directory will be used. To return to the management certificate, use ``Remove-AzureAccount`` to remove the Organizational account.
17240

17341
#### Login directly from PowerShell (Microsoft Azure Active Directory authentication)
17442

17543
```powershell
176-
# Pop up an embedded browser control for you to login
44+
# Displays a browser window for login
17745
Add-AzureAccount
17846
179-
# use the cmdlets to manage your services/applications
180-
New-AzureWebsite -Name mywebsite -Location "West US"
47+
# Interactive login without a browser window
48+
Add-AzureAccount -Credential
18149
```
18250

18351
#### Use publish settings file (Management certificate authentication)
18452

18553
```powershell
186-
# Download a file which contains the publish settings information of your subscription.
187-
# This will open a browser window and ask you to log in to get the file.
54+
# Opens a browser window to login and download publish settings file.
18855
Get-AzurePublishSettingsFile
18956
190-
# Import the file you just downloaded.
191-
# Notice that the file contains credential of your subscription so you don't want to make it public
192-
# (like check in to source control, etc.).
57+
# Import the downloaded file.
58+
# It contains credentials for your account. Keep it safe.
19359
Import-AzurePublishSettingsFile "<file location>"
19460
195-
# Use the cmdlets to manage your services/applications
196-
New-AzureWebsite -Name mywebsite -Location "West US"
19761
```
19862

19963
### Microsoft Azure China
@@ -202,25 +66,19 @@ New-AzureWebsite -Name mywebsite -Location "West US"
20266
# Check the environment supported by your Microsoft Azure PowerShell installation.
20367
Get-AzureEnvironment
20468
205-
# Download a file which contains the publish settings information of your subscription.
206-
# Use the -Environment parameter to target Microsoft Azure China.
207-
# This will open a browser window and ask you to log in to get the file.
69+
# Use the -Environment parameter to specify Microsoft Azure China.
70+
# Opens a browser window to login and download publish settings file.
20871
Get-AzurePublishSettingsFile -Environment "AzureChinaCloud"
20972
210-
# Import the file you just downloaded.
211-
# Notice that the file contains credential of your subscription so you don't want to make it public
212-
# (like check in to source control, etc.).
73+
# Import the downloaded file.
74+
# It contains credentials for your account. Keep it safe.
21375
Import-AzurePublishSettingsFile "<file location>"
214-
215-
# Use the cmdlets to manage your services/applications
216-
New-AzureWebsite -Name mywebsite -Location "China East"
21776
```
21877

21978
### Windows Azure Pack
22079

22180
```powershell
222-
# Add your Windows Azure Pack environment to your Microsoft Azure PowerShell installation.
223-
# You will need to know the following information of your Windows Azure Pack environment.
81+
# You will need the following information of your Windows Azure Pack environment.
22482
# 1. URL to download the publish settings file Mandatory
22583
# 2. Management service endpoint Optional
22684
# 3. Management Portal URL Optional
@@ -231,46 +89,29 @@ Add-WAPackEnvironment -Name "MyWAPackEnv" `
23189
-ManagementPortalUrl "<Storage service endpoint>" `
23290
-StorageEndpoint "<Management Portal URL>"
23391
234-
# Download a file which contains the publish settings information of your subscription.
235-
# Use the -Environment parameter to target your Windows Azure Pack environment.
236-
# This will open a browser window and ask you to log in to get the file.
92+
# Use the -Environment parameter to specify your Windows Azure Pack environment.
93+
# Opens a browser window to login and download publish settings file.
23794
Get-WAPackPublishSettingsFile -Environment "MyWAPackEnv"
23895
239-
# Import the file you just downloaded.
240-
# Notice that the file contains credential of your subscription so you don't want to make it public
241-
# (like check in to source control, etc.).
96+
# Import the downloaded file.
97+
# It contains credentials for your account. Keep it safe.
24298
Import-WAPackPublishSettingsFile "<file location>"
24399
244-
# Use the cmdlets to manage your services/applications
245-
New-WAPackWebsite -Name mywebsite
246100
```
247-
## 2 Modes
101+
## Switch-AzureMode
248102

249-
Starting from 0.8.0, we are adding a separate mode for Resource Manager. You can use the following cmdlet to switch between the
103+
Azure Powershell has two modes. Service Management mode is for the original infrastructure and deployment model. Resource Manager mode is for the newer APIs providing templated deployments and role-based access controls.
250104

251-
* Service management: cmdlets using the Azure service management API
252-
* Resource manager: cmdlets using the Azure Resource Manager API
253-
254-
They are not designed to work together.
105+
They are not designed to work together. Switch between the two modes using ```Switch-AzureMode```.
255106

256107
```powershell
257108
Switch-AzureMode AzureServiceManagement
258109
Switch-AzureMode AzureResourceManager
259110
```
260111

261-
## Find Your Way
262-
263-
All the cmdlets can be put into 3 categories:
112+
## Environment-Specific cmdlets
264113

265-
1. Cmdlets support both Microsoft Azure and Windows Azure Pack
266-
2. Cmdlets only support both Microsoft Azure
267-
3. Cmdlets only support Windows Azure Pack
268-
269-
* For category 1, we are using an "Azure" prefix in the cmdlet name and adding an alias with "WAPack" prefix.
270-
* For category 2, we are using an "Azure" prefix in the cmdlet name.
271-
* For category 2, we are using an "WAPack" prefix in the cmdlet name.
272-
273-
So you can use the following cmdlet to find out all the cmdlets for your environment
114+
Some cmdlets support both the public Microsoft Azure environment and your private Windows Azure Pack environment. Some support only one environment. Aliases are used to easily identify the environments a cmdlet supports.
274115

275116
```powershell
276117
# Return all the cmdlets for Microsoft Azure
@@ -280,18 +121,13 @@ Get-Command *Azure*
280121
Get-Command *WAPack*
281122
```
282123

283-
If you want to migrate some scripts from Microsoft Azure to Windows Azure Pack or vice versa, as long as the cmdlets you are using are in category 1, you should be able to migrate smoothly.
284-
285124
## Need Help?
286125

287-
Be sure to check out the [Microsoft Azure Developer Forums on Stack Overflow](http://go.microsoft.com/fwlink/?LinkId=234489) if you have trouble with the provided code.
126+
Check out the [Microsoft Azure Developer Forums on Stack Overflow](http://go.microsoft.com/fwlink/?LinkId=234489) if you have trouble.
288127

289128
## Contribute Code or Provide Feedback
290129

291-
If you would like to become an active contributor to this project please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](http://windowsazure.github.com/guidelines.html).
292-
293-
If you encounter any bugs with the library please file an issue in the [Issues](https://github.com/Azure/azure-powershell/issues) section of the project.
130+
If you would like to contribute to this project, follow the instructions at [Microsoft Azure Open Source Contribution Guidelines](http://azure.github.io/guidelines.html).
294131

295-
# Learn More
132+
If you encounter any bugs, please open an [issue](https://github.com/Azure/azure-powershell/issues).
296133

297-
* [Microsoft Azure Script Center](http://www.azure.microsoft.com/en-us/documentation/scripts/)

0 commit comments

Comments
 (0)