Merge pull request #23 from Azure/dev

Merge from the Azure-powershell/dev

Author: jtlibingus

.github/PULL_REQUEST_TEMPLATE.md

@@ -26,9 +26,9 @@ This checklist is used to make sure that common guidelines for a pull request ar
 
 ### [Cmdlet Signature Guidelines](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md#cmdlet-signature-guidelines)
 - [ ] 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).
-- [ ] Cmdlet specifies `OutputType` attribute if any output is produced - if the cmdlet produces no output, it should implement a `PassThrough` parameter.
+- [ ] Cmdlet specifies `OutputType` attribute if any output is produced - if the cmdlet produces no output, it should implement a `PassThru` parameter.
 
 ### [Cmdlet Parameter Guidelines](https://github.com/Azure/azure-powershell/blob/dev/CONTRIBUTING.md#cmdlet-parameter-guidelines)
 - [ ] Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
 - [ ] 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.
-- [ ] Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.
+- [ ] Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

AzurePowershell.Test.targets

@@ -85,6 +85,7 @@
       <XUnitTests Include=".\src\ResourceManager\Dns\Commands.Dns.Test\bin\Debug\Microsoft.Azure.Commands.Dns.Test.dll"/>
       <XUnitTests Include=".\src\ResourceManager\HDInsight\Commands.HDInsight.Test\bin\Debug\Commands.HDInsight.Test.dll"/>
       <XUnitTests Include=".\src\ResourceManager\Insights\Commands.Insights.Test\bin\Debug\Microsoft.Azure.Commands.Insights.Test.dll"/>
+      <XUnitTests Include=".\src\ResourceManager\IotHub\Commands.IotHub.Test\bin\Debug\Microsoft.Azure.Commands.IotHub.Test.dll"/>
       <XUnitTests Include=".\src\ResourceManager\KeyVault\Commands.KeyVault.Test\bin\Debug\Microsoft.Azure.Commands.KeyVault.Test.dll"/>
       <XUnitTests Include=".\src\ResourceManager\LogicApp\Commands.LogicApp.Test\bin\Debug\Microsoft.Azure.Commands.LogicApp.Test.dll"/>
       <XUnitTests Include=".\src\ResourceManager\Network\Commands.Network.Test\bin\Debug\Microsoft.Azure.Commands.Network.Test.dll"/>
@@ -106,6 +107,8 @@
       <XUnitTests Include=".\src\ResourceManager\UsageAggregates\Commands.UsageAggregates.Test\bin\Debug\Microsoft.Azure.Commands.UsageAggregates.Test.dll"/>
       <XUnitTests Include=".\src\ResourceManager\Websites\Commands.Websites.Test\bin\Debug\Microsoft.Azure.Commands.Websites.Test.dll"/>
       <XUnitTests Include=".\src\Common\Commands.Common.Authentication.Test\bin\Debug\Microsoft.Azure.Commands.Common.Authentication.Test.dll"/>
+	  <XUnitTests Include=".\src\ResourceManager\ServiceBus\Commands.ServiceBus.Test\bin\Debug\Microsoft.Azure.Commands.ServiceBus.Test.dll"/>
+	  <XUnitTests Include=".\src\ResourceManager\EventHub\Commands.EventHub.Test\bin\Debug\Microsoft.Azure.Commands.EventHubs.Test.dll"/>
       <XUnitTests Include="@(AsmXUnitTests)"/>
     </ItemGroup>
     <ItemGroup Condition=" '$(scope)' == 'ServiceManagement' ">
@@ -526,4 +529,3 @@
 
 
 </Project>
-

ChangeLog.md

@@ -22,6 +22,8 @@ This repository contains a set of PowerShell cmdlets for developers and administ
   * App Service (Websites)
   * SQL Database
   * KeyVault
+  * Data Lake Store
+  * Data Lake Analytics
   * Operational Insights
   * Automation
   * Batch
@@ -36,7 +38,7 @@ This repository contains a set of PowerShell cmdlets for developers and administ
   * Scheduler
   * StorSimple
   * Redis Cache
- 
+
 * Windows Azure Pack
   * Web Site: CRUD web site, deployment, configure and get log, start/stop/restart/show web site
   * Service Bus: CRD namespace
@@ -46,7 +48,7 @@ This repository contains a set of PowerShell cmdlets for developers and administ
 * Windows Azure Stack
   * Azure Stack Administration
   * Storage Service Management
-  
+
 
 For detail descriptions and examples of the cmdlets, type
 * ```help azure``` to get all the cmdlets.
@@ -72,7 +74,7 @@ For detail descriptions and examples of the cmdlets, type
 You can also find the standalone installers for all the versions at [Downloads](https://github.com/Azure/azure-powershell/releases)
 
 ### PowerShell Gallery
-1. Install [Windows Management Framework 5 with PowerShellGet cmdlets](https://www.powershellgallery.com/GettingStarted?section=Get%20Started)
+1. Install [Windows Management Framework 5 with PowerShellGet cmdlets](https://msdn.microsoft.com/en-us/powershell/gallery/psgallery/psgallery_gettingstarted)
 2. In an elevated PowerShell session, run  ```Install-Module AzureRM```
 3. Run ```Install-AzureRm```
 4. To install RDFE cmdlets, run ```Install-Module Azure```
@@ -92,7 +94,7 @@ You can also find the standalone installers for all the versions at [Downloads](
 
 In general, follow these steps to start using Microsoft Azure PowerShell
 
-* Get yourself authenticated with Microsoft Azure. For details, please check out [this article](https://azure.microsoft.com/en-us/documentation/articles/install-configure-powershell/).
+* Get yourself authenticated with Microsoft Azure. For details, please check out [this article](https://docs.microsoft.com/powershell/azureps-cmdlets-docs/).
   * 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.
       * Starting from 1.0.0, you can use ```Add-AzureRmAccount -Credential``` to avoid the browser pop up for Organizational account.
       * To use RDFE cmdlets, use ```Add-AzureAccount```

README.md

@@ -45,7 +45,7 @@
     <Scope Condition=" $(Scope) == '' " >all</Scope>
   </PropertyGroup>
   <ItemGroup>
-    <CmdletSolutionsToBuild Include=".\src\Storage\Storage.sln;.\src\ResourceManager\**\*.sln;.\src\ServiceManagement\ServiceManagement.sln"
+    <CmdletSolutionsToBuild Include=".\src\Storage\Storage.sln;.\src\ResourceManager\**\*.sln;.\src\ServiceManagement\ServiceManagement.sln;"
                             Exclude=".\src\ResourceManager\Intune\*.sln"
                             Condition=" '$(Scope)' == 'all' "/>
     <CmdletSolutionsToBuild Include=".\src\ResourceManager\$(Scope)\*.sln" 

build.proj

@@ -3,7 +3,7 @@
 ###### Usage:
 
 1. Start .\tools\PS-VSPrompt.lnk (shortcut), this will start VS Dev Prompt in powershell
-2. Import-Module .\tools\Repo-Tasks.psd1
+2. Import-Module .\Repo-Tasks.psd1
 	1. During import, we allow to load additional functions that users might want to use it in their session.
 	2. If you have any userPreference.ps1 file under %userprofile%/psFiles directory, the module will try to load it by dot sourcing it.
 	2. It will also honor environment variable $env:psuserpreferences and load .ps1 files from the location that is pointed by $env:psuserpreferences

documentation/Repo-Tasks-Module.md

@@ -22,24 +22,23 @@
 	3. Get-Help <CommandName> to get help on individual commands.
 
 ## 2. Accquring TestFramework
-Current Version: [1.4.0-preview](https://www.nuget.org/packages/Microsoft.Rest.ClientRuntime.Azure.TestFramework/1.4.0-preview)
 
-Nuget command to install current version
+TestFramework is available on NuGet at https://www.nuget.org/packages/Microsoft.Rest.ClientRuntime.Azure.TestFramework/ .
 
-    Install-Package Microsoft.Rest.ClientRuntime.Azure.TestFramework -v 1.4.0-preview -Pre
+Instructions to manually download it are available on NuGet. However TestFramework will be downloaded automatically as part of the build process, so manually downloading it should generally be unnecessary.
 
 ## 3. Setup prior to Record/Playback of tests
 In order to Record/Playback a test, you need to setup a connection string that consists various key/value pairs that provides information to the test environment.
 
 #### 3.1 Environment Variables
+
 > TEST_CSM_ORGID_AUTHENTICATION
 
-> AZURE_TEST_MODE
+This is the connection string that determined how to connect to Azure. This includes both your authentiation and the Azure environment to connect to.
 
-    e.g.	
-    TEST_CSM_ORGID_AUTHENTICATION=SubscriptionId=<valid SubscriptionId>;ServicePrincipal=<ClientId>;ServicePrincipalSecret=<Client Secret>;AADTenant=<tenantId>;Environment=Prod;BaseUri=https://management.azure.com/;AADAuthEndpoint=https://login.windows.net/;GraphUri=https://graph.windows.net/
+> AZURE_TEST_MODE
 
-	AZURE_TEST_MODE=Record
+This specifies whether test framework will `Record` test sessions or `Playback` previously recorded test sessions.
 
 #### 3.2.  Supported Keys in connection string
 	* ManagementCertificate
@@ -63,24 +62,27 @@ In order to Record/Playback a test, you need to setup a connection string that c
 	* AADAuthEndpoint
 	* GraphTokenAudienceUri
 
-#### 3.3. Existing Defaults
-	 Environment.Prod
-		AADAuthUri = "https://login.microsoftonline.com"
-	    GalleryUri = "https://gallery.azure.com/"
-	    GraphUri = "https://graph.windows.net/"
-	    IbizaPortalUri = "https://portal.azure.com/"
-	    RdfePortalUri = "http://go.microsoft.com/fwlink/?LinkId=254433"
-	    ResourceManagementUri = "https://management.azure.com/"
-	    ServiceManagementUri = "https://management.core.windows.net"
-	    AADTokenAudienceUri = "https://management.core.windows.net"
-	    GraphTokenAudienceUri = "https://graph.windows.net/"
-	    DataLakeStoreServiceUri = "https://azuredatalakestore.net"
-	    DataLakeAnalyticsJobAndCatalogServiceUri = "https://azuredatalakeanalytics.net"
-
-----------
-
-	Environment.Dogfood
-		AADAuthUri = "https://login.windows-ppe.net";
+#### 3.3. Environment Defaults
+
+Setting `Environment` in the connection string will result in the following default values:
+
+##### Environment = Prod
+
+	AADAuthUri = "https://login.microsoftonline.com"
+	GalleryUri = "https://gallery.azure.com/"
+	GraphUri = "https://graph.windows.net/"
+	IbizaPortalUri = "https://portal.azure.com/"
+	RdfePortalUri = "http://go.microsoft.com/fwlink/?LinkId=254433"
+	ResourceManagementUri = "https://management.azure.com/"
+	ServiceManagementUri = "https://management.core.windows.net"
+	AADTokenAudienceUri = "https://management.core.windows.net"
+	GraphTokenAudienceUri = "https://graph.windows.net/"
+	DataLakeStoreServiceUri = "https://azuredatalakestore.net"
+	DataLakeAnalyticsJobAndCatalogServiceUri = "https://azuredatalakeanalytics.net"
+
+##### Environment = Dogfood
+
+	AADAuthUri = "https://login.windows-ppe.net";
         GalleryUri = "https://df.gallery.azure-test.net/";
         GraphUri = "https://graph.ppe.windows.net/";
         IbizaPortalUri = "http://df.onecloud.azure-test.net";
@@ -92,10 +94,9 @@ In order to Record/Playback a test, you need to setup a connection string that c
         DataLakeStoreServiceUri = "https://caboaccountdogfood.net";
         DataLakeAnalyticsJobAndCatalogServiceUri = "https://konaaccountdogfood.net";
 
-----------
+##### Environment = Next
 
-	Environment.Next
-		AADAuthUri = "https://login.windows-ppe.net"
+	AADAuthUri = "https://login.windows-ppe.net"
         GalleryUri = "https://next.gallery.azure-test.net/"
         GraphUri = "https://graph.ppe.windows.net/"
         IbizaPortalUri = "http://next.onecloud.azure-test.net"
@@ -107,10 +108,9 @@ In order to Record/Playback a test, you need to setup a connection string that c
         DataLakeStoreServiceUri = "https://caboaccountdogfood.net"
         DataLakeAnalyticsJobAndCatalogServiceUri = "https://konaaccountdogfood.net"
 
-----------
+##### Environment = Current
 
-	Environment.Current
-		AADAuthUri = "https://login.windows-ppe.net"
+	AADAuthUri = "https://login.windows-ppe.net"
         GalleryUri = "https://df.gallery.azure-test.net/"
         GraphUri = "https://graph.ppe.windows.net/"
         IbizaPortalUri = "http://df.onecloud.azure-test.net"
@@ -123,17 +123,43 @@ In order to Record/Playback a test, you need to setup a connection string that c
         DataLakeAnalyticsJoAbndCatalogServiceUri = "https://konaaccountdogfood.net"
 
 ## 4. Record/Playback Test
+
 #### Playback Test
-1. The default mode is Playback mode, so no setting up of connection string is required.
+
+The default mode is Playback mode, so no setting up of connection string is required.
 
 #### Record Test with Interactive login using OrgId
-	TEST_CSM_ORGID_AUTHENTICATION=SubsctiptionId={SubId};UserId={orgId};AADTenant={tenantId};Environment={env};HttpRecorderMode=Record;
+
+This is no longer the preferred option because it only works when running on .NET Framework. When running on .NET Core you may get an error like `Interactive Login is supported only in NET45 projects`.
+
+To use this option, set the following environment variable before starting Visual Studio:
+
+	TEST_CSM_ORGID_AUTHENTICATION=SubscriptionId={SubId};UserId={orgId};AADTenant={tenantId};Environment={env};HttpRecorderMode=Record;
 
 #### Record Test with ServicePrincipal
-	TEST_CSM_ORGID_AUTHENTICATION=SubsctiptionId={SubId};ServicePrincipal={clientId};ServicePrincipalSecret={clientSecret};AADTenant={tenantId};Environment={env};HttpRecorderMode=Record;
 
-2. Run the test and make sure that you got a generated .json file that matches the test name in 	the bin folder under *SessionRecords folder
-3. Copy SessionRecords folder inside the test project and add all *.json files in Visual Studio 	setting "Copy to Output Directory" property to "Copy if newer"
+This is the preferred option because it works with both .NET Framework and .NET Core.
+
+To create a service principal, follow the [Azure AD guide to create a Application Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal#create-an-active-directory-application). The application type should be `Web app / API` and the sign-on URL value is irrelevant (you can set any value).
+
+After the service principal is created, you will need to give it access to Azure resources. This can be done with the following PowerShell command, with the [Service Principal Application ID](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal#get-application-id-and-authentication-key) (this is a guid, not the display name of the service principal) substituted in for `{clientId}`.
+
+	New-AzureRmRoleAssignment -ServicePrincipalName {clientId} -RoleDefinitionName Contributor
+
+To use this option, set the following environment variable before starting Visual Studio. The following values are substituted into the below connection string:
+
+`clientId`: The [Service Principal Application ID](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal#get-application-id-and-authentication-key)
+
+`clientSecret`: A [Service Principal Authentication Key](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal#get-application-id-and-authentication-key)
+
+`tenantId`: The [AAD Tenant ID](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal#get-tenant-id)
+
+
+	TEST_CSM_ORGID_AUTHENTICATION=SubscriptionId={SubId};ServicePrincipal={clientId};ServicePrincipalSecret={clientSecret};AADTenant={tenantId};Environment={env};HttpRecorderMode=Record;
+
+
+2. Run the test and make sure that you got a generated .json file that matches the test name in the bin folder under *SessionRecords folder
+3. Copy SessionRecords folder inside the test project and add all *.json files in Visual Studio setting "Copy to Output Directory" property to "Copy if newer"
 4. To assure that the records work fine, delete the connection string (default mode is Playback mode) OR change HttpRecorderMode within the connection string to "Playback"
 
 ## 5. Change Test Environment settings at run-time
@@ -149,4 +175,4 @@ In order to Record/Playback a test, you need to setup a connection string that c
 	TestEnvironment.Endpoints.GraphUri = new Uri("https://newGraphUri.windows.net");
 
 ###Note:###
-Changing the above properties at run-time has the potential to hard code few things in your tests. Best practice would be to use these properties to change values at run-time from immediate window at run-time and avoid hard-coding certain values.
+Changing the above properties at run-time has the potential to hard code few things in your tests. Best practice would be to use these properties to change values at run-time from immediate window at run-time and avoid hard-coding certain values.

documentation/Using-Azure-TestFramework.md

@@ -25,4 +25,5 @@
     https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md
 -->
 
-# Upcoming Breaking Changes
+# Upcoming Breaking Changes
+