Skip to content

Commit a11946f

Browse files
author
Graham Priestley
authored
Merge branch 'preview' into Graham71298
2 parents 6038eb3 + 2683def commit a11946f

File tree

925 files changed

+547304
-190152
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

925 files changed

+547304
-190152
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,24 @@ If applicable, reference the bug/issue that this pull request fixes here.
1111

1212
This checklist is used to make sure that common guidelines for a pull request are followed. You can find a more complete discussion of PowerShell cmdlet best practices [here](https://msdn.microsoft.com/en-us/library/dd878270(v=vs.85).aspx).
1313

14-
- [ ] **I have read the [contribution guidelines](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md).**
15-
- [ ] **If changes were made to any cmdlet, the XML help was regenerated using the [platyPSHelp module](https://github.com/Azure/azure-powershell/blob/dev/documentation/platyPSHelp-documentation.md).**
16-
- [ ] **If any large changes are made to a service, they are reflected in the respective [change log](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md#updating-the-change-log).**
14+
- [ ] **I have read the [contribution guidelines](https://github.com/Azure/azure-powershell/blob/preview/CONTRIBUTING.md).**
15+
- [ ] **If changes were made to any cmdlet, the XML help was regenerated using the [platyPSHelp module](https://github.com/Azure/azure-powershell/blob/preview/documentation/help-generation.md).**
16+
- [ ] **If any large changes are made to a service, they are reflected in the respective [change log](https://github.com/Azure/azure-powershell/blob/preview/CONTRIBUTING.md#updating-the-change-log).**
1717

18-
### [General Guidelines](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md#general-guidelines)
18+
### [General Guidelines](https://github.com/Azure/azure-powershell/blob/preview/CONTRIBUTING.md#general-guidelines)
1919
- [ ] Title of the pull request is clear and informative.
20-
- [ ] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, [see this page](https://github.com/Azure/azure-powershell/blob/dev/documentation/cleaning-up-commits.md).
21-
- [ ] The pull request does not introduce [breaking changes](https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes.md) (unless a major version change occurs in the assembly and module).
20+
- [ ] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, [see this page](https://github.com/Azure/azure-powershell/blob/preview/documentation/cleaning-up-commits.md).
21+
- [ ] The pull request does not introduce [breaking changes](https://github.com/Azure/azure-powershell/blob/preview/documentation/breaking-changes/breaking-changes-definition.md) (unless a major version change occurs in the assembly and module).
2222

23-
### [Testing Guidelines](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md#testing-guidelines)
23+
### [Testing Guidelines](https://github.com/Azure/azure-powershell/blob/preview/CONTRIBUTING.md#testing-guidelines)
2424
- [ ] Pull request includes test coverage for the included changes.
2525
- [ ] PowerShell scripts used in tests should do any necessary setup as part of the test or suite setup, and should not use hard-coded values for locations or existing resources.
2626

27-
### [Cmdlet Signature Guidelines](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md#cmdlet-signature-guidelines)
28-
- [ ] New cmdlets that make changes or have side effects should implement `ShouldProcess` and have `SupportShouldProcess=true` specified in the cmdlet attribute. You can find more information on `ShouldProcess` [here](https://gist.github.com/markcowl/338e16fe5c8bbf195aff9f8af0db585d#what-is-the-change).
27+
### [Cmdlet Signature Guidelines](https://github.com/Azure/azure-powershell/blob/preview/CONTRIBUTING.md#cmdlet-signature-guidelines)
28+
- [ ] New cmdlets that make changes or have side effects should implement `ShouldProcess` and have `SupportShouldProcess=true` specified in the cmdlet attribute. You can find more information on `ShouldProcess` [here](https://github.com/Azure/azure-powershell/wiki/PowerShell-Cmdlet-Design-Guidelines#supportsshouldprocess).
2929
- [ ] Cmdlet specifies `OutputType` attribute if any output is produced - if the cmdlet produces no output, it should implement a `PassThru` parameter.
3030

31-
### [Cmdlet Parameter Guidelines](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md#cmdlet-parameter-guidelines)
31+
### [Cmdlet Parameter Guidelines](https://github.com/Azure/azure-powershell/blob/preview/CONTRIBUTING.md#cmdlet-parameter-guidelines)
3232
- [ ] Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
3333
- [ ] Complex parameter types are discouraged - a parameter type should be simple types as often as possible. If complex types are used, they should be shallow and easily creatable from a constructor or another cmdlet.
3434
- [ ] Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

ChangeLog.md

Lines changed: 78 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,80 @@
1-
## 2017.05.12 - Version 4.0.1
1+
## 2017.06.07 - Version 4.1.0
2+
* AnalysisServices
3+
* New SKUs added: B1, B2, S0
4+
* Scale up/down support added
5+
* CognitiveServices
6+
* Update detailed display of license agreements when creating Cognitive Services resources
7+
* Compute
8+
* Fix Test-AzureRmVMAEMExtension for virtual machines with multiple managed disks
9+
* Updated Set-AzureRmVMAEMExtension: Add caching information for Premium managed disks
10+
* Add-AzureRmVhd: The size limit on vhd is increased to 4TB.
11+
* Stop-AzureRmVM: Clarify documentation for STayProvisioned parameter
12+
* New-AzureRmDiskUpdateConfig
13+
* Deprecated parameters CreateOption, StorageAccountId, ImageReference, SourceUri, SourceResourceId
14+
* Set-AzureRmDiskUpdateImageReference: Deprecated cmdlet
15+
* New-AzureRmSnapshotUpdateConfig
16+
* Deprecated parameters CreateOption, StorageAccountId, ImageReference, SourceUri, SourceResourceId
17+
* Set-AzureRmSnapshotUpdateImageReference: Deprecated Cmdlet
18+
* DataLakeStore
19+
* Enable-AzureRmDataLakeStoreKeyVault (Enable-AdlStoreKeyVault)
20+
* Enable KeyVault managed encryption for a DataLake Store
21+
* DevTestLabs
22+
* Update cmdlets to work with current and updated DevTest Labs API version.
23+
* IotHub
24+
* Add Routing support for IoTHub cmdlets
25+
* KeyVault
26+
* New Cmdlets to support KeyVault Managed Storage Account Keys
27+
* Get-AzureKeyVaultManagedStorageAccount
28+
* Add-AzureKeyVaultManagedStorageAccount
29+
* Remove-AzureKeyVaultManagedStorageAccount
30+
* Update-AzureKeyVaultManagedStorageAccount
31+
* Update-AzureKeyVaultManagedStorageAccountKey
32+
* Get-AzureKeyVaultManagedStorageSasDefinition
33+
* Set-AzureKeyVaultManagedStorageSasDefinition
34+
* Remove-AzureKeyVaultManagedStorageSasDefinition
35+
* Network
36+
* Get-AzureRmNetworkUsage: New cmdlet to show network usage and capacity details
37+
* Added new GatewaySku options for VirtualNetworkGateways
38+
* VpnGw1, VpnGw2, VpnGw3 are the new Skus added for Vpn gateways
39+
* Set-AzureRmNetworkWatcherConfigFlowLog
40+
* Fixed help examples
41+
* NotificationHubs
42+
* Transparent Update to NotificationHubs cmdlets for new API
43+
* Profile
44+
* Resolve-AzureRmError
45+
* New cmdlet to show details of errors and exceptions thrown by cmdlets, including server request/response data
46+
* Send-Feedback
47+
* Enabled sending feedback without logging in
48+
* Get-AzureRmSubscription
49+
* Fix bug in retreiving CSP subscriptions
50+
* Resources
51+
* Fixed issue where Get-AzureRMRoleAssignment would result in a Bad Request if the number of roleassignments where greater than 1000
52+
* Users can now use Get-AzureRMRoleAssignment even if the roleassignments to be returned is greater than 1000
53+
* Sql
54+
* Restore-AzureRmSqlDatabase: Update documentation example
55+
* Storage
56+
* Add AssignIdentity setting support to resource mode storage account cmdlets
57+
* New-AzureRmStorageAccount
58+
* Set-AzureRmStorageAccount
59+
* Add Customer Key Support to resource mode storage account cmdlets
60+
* Set-AzureRmStorageAccount
61+
* New-AzureRmStorageAccountEncryptionKeySource
62+
* TrafficManager
63+
64+
* New Monitor settings 'MonitorIntervalInSeconds', 'MonitorTimeoutInSeconds', 'MonitorToleratedNumberOfFailures'
65+
* New Monitor protocol 'TCP'
66+
* ServiceManagement
67+
* Add-AzureVhd: The size limit on vhd is increased to 4TB.
68+
* New-AzureBGPPeering: Support LegacyMode
69+
* Azure.Storage
70+
* Update help for parameters that accept wildcard characters and update StorageContext type
71+
72+
## 2017.05.23 - Version 4.0.2
73+
* Profile
74+
* Add-AzureRmAccount
75+
* Added `-EnvironmentName` parameter alis for backward compatibility with 2.x versions of AzureRM.profile
76+
77+
## 2017.05.12 - Version 4.0.1
278
* Fix issue with New-AzureStorageContext in offline scenarios: https://github.com/Azure/azure-powershell/issues/3939
379

480
## 2017.05.10 - Version 4.0.0
@@ -3214,4 +3290,4 @@ Virtual Network cmdlets
32143290
* iisnode 0.1.13
32153291

32163292
2011.12.09 Version 0.5.0
3217-
* Initial Release
3293+
* Initial Release

README.md

Lines changed: 72 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,56 @@
44

55
This repository contains a set of PowerShell cmdlets for developers and administrators to develop, deploy and manage Microsoft Azure applications.
66

7-
* For documentation on how to build and deploy applications to Microsoft Azure please see the [Microsoft Azure Documentation Center](https://azure.microsoft.com/en-us/documentation/).
8-
* For comprehensive documentation on the developer cmdlets see [How to install and configure Azure PowerShell](https://azure.microsoft.com/en-us/documentation/articles/install-configure-powershell/).
9-
* 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).
10-
* For suggesting improvements, join our improvement discussion ([#3692](https://github.com/Azure/azure-powershell/issues/3692)).
7+
* For documentation on how to build and deploy applications to Microsoft Azure please see the [Microsoft Azure Documentation Center](https://docs.microsoft.com/en-us/azure/).
8+
* For comprehensive documentation on the developer cmdlets see the [overview of Azure PowerShell](aka.ms/azpsdocs).
9+
* For suggesting improvements, join our improvement discussion ([Issue #3692](https://github.com/Azure/azure-powershell/issues/3692)).
1110

1211
## Features
1312

1413
* Account management
1514
* Login with Microsoft account, Organizational account, or Service Principal through Microsoft Azure Active Directory
16-
* Save Credentials to disk with Save-AzureRmProfile and load saved credentials using Select-AzureRmProfile
15+
* Save Credentials to disk with Save-AzureRmContext and load saved credentials using Import-AzureRmContext
1716
* Environment
1817
* Get the different out-of-box Microsoft Azure environments
1918
* Add/Set/Remove customized environments (like your Azure Stack or Windows Azure Pack environments)
2019
* Management and data plane cmdlets for Azure services in ARM and RDFE
21-
* VM
22-
* Storage
23-
* Network
20+
* Virtual Machine
2421
* App Service (Websites)
2522
* SQL Database
26-
* KeyVault
27-
* Data Lake Store
28-
* Data Lake Analytics
29-
* Operational Insights
30-
* Automation
31-
* Batch
23+
* Storage
3224
* Backup
33-
* RecoveryServices and SiteRecovery
34-
* Stream Analytics
35-
* Traffic Manager
36-
* DataFactories
37-
* DNS
3825
* HDInsight
26+
* Batch
27+
* Container Registry
28+
* StorSimple
29+
* API Management
30+
* IoT Hub
31+
* Content Delivery Network (CDN)
3932
* Express Route
33+
* RecoveryServices and SiteRecovery
34+
* DNS
35+
* Machine Learning
36+
* Service Fabric
37+
* Network
38+
* Media Services
39+
* Stream Analytics
40+
* Event Hubs
41+
* Data Factory
42+
* Key Vault
43+
* Service Bus
4044
* Scheduler
41-
* StorSimple
45+
* DevTest Labs
46+
* Notification Hubs
47+
* Automation
48+
* Operational Insights
49+
* Traffic Manager
4250
* Redis Cache
51+
* Power BI Embedded
52+
* Data Lake Store
53+
* Data Lake Analytics
54+
* Cognitive Services
55+
* Logic Apps
56+
* Analysis Services
4357

4458
* Windows Azure Pack
4559
* Web Site: CRUD web site, deployment, configure and get log, start/stop/restart/show web site
@@ -53,9 +67,9 @@ This repository contains a set of PowerShell cmdlets for developers and administ
5367

5468

5569
For detail descriptions and examples of the cmdlets, type
56-
* ```help azure``` to get all the cmdlets.
57-
* ```help azurerm``` to get all the Azure Resource Manager (ARM) cmdlets.
58-
* ```help <cmdlet name>``` to get the details of a specific cmdlet.
70+
* ```Get-Help Azure``` to get all of the Azure PowerShell cmdlets.
71+
* ```Get-Help AzureRM``` to get all of the Azure Resource Manager (ARM) cmdlets.
72+
* ```Get-Help <cmdlet name>``` to get the details of a specific cmdlet.
5973

6074
## Supported Environments
6175

@@ -67,42 +81,33 @@ For detail descriptions and examples of the cmdlets, type
6781

6882
## Installation
6983

84+
### PowerShell Gallery
85+
1. Install [Windows Management Framework 5 with PowerShellGet cmdlets](https://msdn.microsoft.com/en-us/powershell/gallery/psgallery/psgallery_gettingstarted)
86+
2. In an elevated PowerShell session, run ```Install-Module AzureRM```
87+
3. To install RDFE cmdlets, run ```Install-Module Azure```
88+
7089
### Microsoft Web Platform Installer
7190

7291
1. Install [Microsoft Web Platform Installer](https://www.microsoft.com/web/downloads/platform.aspx).
7392
2. Open Microsoft Web Platform Installer and search for __Microsoft Azure PowerShell__.
7493
3. Install.
7594

76-
You can also find the standalone installers for all the versions at [Downloads](https://github.com/Azure/azure-powershell/releases)
77-
78-
### PowerShell Gallery
79-
1. Install [Windows Management Framework 5 with PowerShellGet cmdlets](https://msdn.microsoft.com/en-us/powershell/gallery/psgallery/psgallery_gettingstarted)
80-
2. In an elevated PowerShell session, run ```Install-Module AzureRM```
81-
3. Run ```Install-AzureRm```
82-
4. To install RDFE cmdlets, run ```Install-Module Azure```
83-
84-
### Source Code
85-
86-
1. Download the source code from GitHub repo
87-
2. Follow the [Azure PowerShell Developer Guide](https://github.com/Azure/azure-powershell/wiki/Azure-Powershell-Developer-Guide)
95+
You can also find the standalone installers for all versions of Azure PowerShell in the [releases section](https://github.com/Azure/azure-powershell/releases)
8896

8997
### Supported PowerShell Versions
9098

91-
* [Windows Management Framework 3] (https://www.microsoft.com/en-us/download/details.aspx?id=34595)
92-
* [Windows Management Framework 4] (https://www.microsoft.com/en-us/download/details.aspx?id=40855)
93-
* [Windows Management Framework 5] (https://www.microsoft.com/en-us/download/details.aspx?id=50395)
99+
* [Windows Management Framework 3](https://www.microsoft.com/en-us/download/details.aspx?id=34595)
100+
* [Windows Management Framework 4](https://www.microsoft.com/en-us/download/details.aspx?id=40855)
101+
* [Windows Management Framework 5](https://www.microsoft.com/en-us/download/details.aspx?id=50395)
94102

95-
## Get Started
103+
## Using Azure PowerShell
96104

97105
In general, follow these steps to start using Microsoft Azure PowerShell
98106

99-
* Get yourself authenticated with Microsoft Azure. For details, please check out [this article](https://docs.microsoft.com/powershell/azureps-cmdlets-docs/).
100-
* 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.
101-
* Starting from 1.0.0, you can use ```Add-AzureRmAccount -Credential``` to avoid the browser pop up for Organizational account.
102-
* To use RDFE cmdlets, use ```Add-AzureAccount```
107+
* Get yourself authenticated with Microsoft Azure. For details, please check out [this article](https://docs.microsoft.com/en-us/powershell/azure/authenticate-azureps).
103108
* Use the cmdlets
104109

105-
The first step can be different for different environment you are targeting. Following are detail instructions for each supported environment.
110+
The first step can be different for the possible environments you could be targeting. The following are detailed instructions for each supported environment.
106111

107112
### Microsoft Azure
108113

@@ -111,10 +116,13 @@ If you use both mechanisms on the same subscription, Microsoft Azure Active Dire
111116
#### Login directly from PowerShell (Microsoft Azure Active Directory authentication)
112117

113118
```powershell
114-
# Pop up an embedded browser control for you to login
119+
# Interactive login - you will get a dialog box asking for your Azure credentials
115120
Add-AzureRmAccount
116121
117-
# use the cmdlets to manage your services/applications
122+
# Non-interactive login - use service principals
123+
Add-AzureRmAccount -ServicePrincipal -ApplicationId "http://my-app" -Credential $pscredential -TenantId $tenantid
124+
125+
# Use the cmdlets to manage your services/applications
118126
New-AzureRmResourceGroup -Name myresourceGroup -Location "West US"
119127
```
120128

@@ -123,7 +131,7 @@ New-AzureRmResourceGroup -Name myresourceGroup -Location "West US"
123131
```powershell
124132
Add-AzureRmAccount -EnvironmentName AzureChinaCloud
125133
126-
# use the cmdlets to manage your services/applications
134+
# Use the cmdlets to manage your services/applications
127135
New-AzureRmResourceGroup -Name myresourceGroup -Location "China East"
128136
```
129137

@@ -132,10 +140,19 @@ New-AzureRmResourceGroup -Name myresourceGroup -Location "China East"
132140
```powershell
133141
Add-AzureRmAccount -EnvironmentName AzureUSGovernment
134142
135-
# use the cmdlets to manage your services/applications
143+
# Use the cmdlets to manage your services/applications
136144
New-AzureRmResourceGroup -Name myresourceGroup -Location "US Gov Virginia"
137145
```
138146

147+
### Microsoft Azure Germany
148+
149+
```powershell
150+
Add-AzureRmAccount -EnvironmentName AzureGermanCloud
151+
152+
# Use the cmdlets to manage your services/applications
153+
New-AzureRmResourceGroup -Name myresourceGroup -Location "Germany Central"
154+
```
155+
139156
### Windows Azure Pack
140157

141158
```powershell
@@ -169,16 +186,17 @@ New-WAPackWebsite -Name mywebsite
169186

170187
All the cmdlets can be put into 3 categories:
171188

172-
1. ARM management cmdlets use the 'AzureRm' prefix (New-AzureRmResourceGroup, Get-AzureRmVM)
173-
2. Legacy RDFE management cmdlets use the 'Azure' prefix (Get-AzureVM)
174-
3. Data plane cmdlets that work in ARM or RDFE use the 'Azure' prefix (Get-AzureBlob)
189+
1. ARM management cmdlets use the `AzureRm` prefix (New-AzureRmResourceGroup, Get-AzureRmVM)
190+
2. Legacy RDFE management cmdlets use the `Azure` prefix (Get-AzureVM)
191+
3. Data plane cmdlets that work in ARM or RDFE use the `Azure` prefix (Get-AzureBlob)
175192

176193

177194
You can use the following cmdlet to find out all the cmdlets for your environment
178195

179196
```powershell
180197
# Return all the cmdlets for Azure Resource Manager (ARM)
181198
Get-Command *AzureRm*
199+
182200
# Return all the cmdlets for Microsoft Azure
183201
Get-Command *Azure*
184202
@@ -190,15 +208,15 @@ If you want to migrate some scripts from Microsoft Azure to Windows Azure Pack o
190208

191209
## Need Help?
192210

193-
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.
211+
Be sure to check out the [Azure Support Community](https://azure.microsoft.com/en-us/support/forums/) if you have trouble with the provided code.
194212

195213
## Contribute Code or Provide Feedback
196214

197215
If you would like to become an active contributor to this project please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](https://azure.github.io/guidelines/).
198216

199-
More information about contributing to this repo can be found in [CONTRIBUTING md](https://github.com/Azure/azure-powershell/blob/preview/CONTRIBUTING.md) and the [Documentation](https://github.com/Azure/azure-powershell/tree/preview/documentation) folder.
217+
More information about contributing to this repo can be found in [CONTRIBUTING md](https://github.com/Azure/azure-powershell/blob/preview/CONTRIBUTING.md) and the [Azure PowerShell Developer Guide](https://github.com/Azure/azure-powershell/wiki/Azure-Powershell-Developer-Guide) folder.
200218

201-
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.
219+
If you encounter any bugs with the library please file an issue in the [issues section](https://github.com/Azure/azure-powershell/issues) section of the project.
202220

203221
# Learn More
204222

0 commit comments

Comments
 (0)