Healthcare APIs Powershell BYOK Updates (#13518)

* Implementing changes for BYOK healthcareapis

* Fixing build error in healthcareapis set azure method

* Regenerating documentation

* Fixing bugs and updating recording file

* Healthcareapis
* Updating help files
* Updating test recording
* Removing unused code in test script

* Addressing PR comments

* Removing trailing " from help file

* Fixing build errors and updating test record file

* Update ChangeLog.md

Co-authored-by: Mark Baker <[email protected]>
Co-authored-by: Jin Lei <[email protected]>

Author: 3 people

src/HealthcareApis/HealthcareApis.Test/ScenarioTests/Common.ps1

@@ -48,6 +48,15 @@ function Get-OfferThroughput
     return 1000
 }
 
+<#
+.SYNOPSIS
+Gets keyVaultKeyUri value
+#>
+function Get-KeyVaultKeyUri
+{
+    return "https://pshealthapitestvault.vault.azure.net/keys/PSKey1"
+}
+
 <#
 .SYNOPSIS
 Gets kind value

src/HealthcareApis/HealthcareApis.Test/ScenarioTests/HealthcareApisServiceTests.ps1

@@ -28,6 +28,7 @@ function Test-AzRmHealthcareApisService{
 	$rgname = Get-ResourceGroupName
 	$rname = Get-ResourceName
 	$location = Get-Location
+	$keyVaultKeyUri = Get-KeyVaultKeyUri
 	$offerThroughput =  Get-OfferThroughput
 	$kind = Get-Kind
 	$object_id = Get-AccessPolicyObjectID;
@@ -40,12 +41,13 @@ function Test-AzRmHealthcareApisService{
 		New-AzResourceGroup -Name $rgname -Location $location
 
 		# Create App
-		$created = New-AzHealthcareApisService -Name $rname -ResourceGroupName $rgname -Location $location -Kind $kind -CosmosOfferThroughput $offerThroughput -ManagedIdentity -ExportStorageAccountName $storageAccountName;
+		$created = New-AzHealthcareApisService -Name $rname -ResourceGroupName $rgname -Location $location -Kind $kind -CosmosKeyVaultKeyUri $keyVaultKeyUri -CosmosOfferThroughput $offerThroughput -ManagedIdentity -ExportStorageAccountName $storageAccountName;
 
 	    $actual = Get-AzHealthcareApisService -ResourceGroupName $rgname -Name $rname
 
 		# Assert
 		Assert-AreEqual $rname $actual.Name
+		Assert-AreEqual $keyVaultKeyUri $actual.CosmosDbKeyVaultKeyUri
 		Assert-AreEqual $offerThroughput $actual.CosmosDbOfferThroughput
 		Assert-AreEqual $kind $actual.Kind
 		Assert-AreEqual "https://$rname.azurehealthcareapis.com" $actual.Audience
@@ -55,13 +57,15 @@ function Test-AzRmHealthcareApisService{
 		Assert-NotNull $actual.IdentityTenantId
 
 		#Update using parameters
-		$newOfferThroughput = $offerThroughput - 600
-		$updated = Set-AzHealthcareApisService -ResourceId $actual.Id -CosmosOfferThroughput $newOfferThroughput -DisableManagedIdentity;
+		$newKeyVaultKeyUri = "https://pshealthapitestvault.vault.azure.net/keys/PSKey2"
+		$newOfferThroughput = 400
+		$updated = Set-AzHealthcareApisService -ResourceId $actual.Id -CosmosKeyVaultKeyUri $newKeyVaultKeyUri -CosmosOfferThroughput $newOfferThroughput -DisableManagedIdentity;
 
 		$updatedAccount = Get-AzHealthcareApisService -ResourceGroupName $rgname -Name $rname
 
 		# Assert the update
 		Assert-AreEqual $rname $updatedAccount.Name
+		Assert-AreEqual $newKeyVaultKeyUri $updatedAccount.CosmosDbKeyVaultKeyUri
 		Assert-AreEqual $newOfferThroughput $updatedAccount.CosmosDbOfferThroughput
 		Assert-AreEqual "None" $updatedAccount.IdentityType
 

src/HealthcareApis/HealthcareApis.Test/SessionRecords/Microsoft.Azure.Commands.HealthcareApisService.Test.ScenarioTests.HealthcareApisServiceTests/TestAzRmHealthcareApisService.json

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Added support for customer managed keys
 
 ## Version 3.0.0
 * Updated the SDK version to 3.0.0

src/HealthcareApis/HealthcareApis/ChangeLog.md

@@ -12,18 +12,18 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
-using System.Collections.Generic;
-using System.Management.Automation;
-using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
-using System.Collections;
-using Microsoft.Azure.Management.HealthcareApis.Models;
-using Microsoft.Azure.Management.HealthcareApis;
-using Microsoft.Azure.Commands.HealthcareApis.Models;
 using Microsoft.Azure.Commands.HealthcareApis.Common;
-using Microsoft.Azure.Commands.ResourceManager.Common.Tags;
+using Microsoft.Azure.Commands.HealthcareApis.Models;
 using Microsoft.Azure.Commands.HealthcareApis.Properties;
-using System;
+using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
+using Microsoft.Azure.Commands.ResourceManager.Common.Tags;
+using Microsoft.Azure.Management.HealthcareApis;
+using Microsoft.Azure.Management.HealthcareApis.Models;
 using Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Common;
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Management.Automation;
 
 namespace Microsoft.Azure.Commands.HealthcareApis.Commands
 {
@@ -114,6 +114,12 @@ public class NewAzureRmHealthcareApisService : HealthcareApisBaseCmdlet
         [ValidateNotNullOrEmpty]
         public string[] CorsOrigin { get; set; }
 
+        [Parameter(
+           Mandatory = false,
+           HelpMessage = "HealthcareApis Fhir Service CosmosKeyVaultKeyUri. The URI of the customer-managed key for the backing database.")]
+        [ValidateNotNullOrEmpty]
+        public string CosmosKeyVaultKeyUri { get; set; }
+
         [Parameter(
            Mandatory = false,
            HelpMessage = "HealthcareApis Fhir Service CosmosOfferThroughput.")]
@@ -180,16 +186,16 @@ public override void ExecuteCmdlet()
                         Properties = new ServicesProperties()
                         {
                             AuthenticationConfiguration = new ServiceAuthenticationConfigurationInfo() { Authority = GetAuthority(), Audience = GetAudience(), SmartProxyEnabled = EnableSmartProxy.ToBool() },
-                            CosmosDbConfiguration = new ServiceCosmosDbConfigurationInfo() { OfferThroughput = GetCosmosDBThroughput() },
+                            CosmosDbConfiguration = new ServiceCosmosDbConfigurationInfo() { OfferThroughput = GetCosmosDBThroughput(), KeyVaultKeyUri = GetCosmosDBKeyVaultKeyUri() },
                             CorsConfiguration = new ServiceCorsConfigurationInfo() { Origins = CorsOrigin, Headers = CorsHeader, Methods = CorsMethod, MaxAge = CorsMaxAge, AllowCredentials = AllowCorsCredential },
-                            ExportConfiguration = new ServiceExportConfigurationInfo() { StorageAccountName = ExportStorageAccountName},
+                            ExportConfiguration = new ServiceExportConfigurationInfo() { StorageAccountName = ExportStorageAccountName },
                             AccessPolicies = accessPolicies,
                         }
                     };
-                    
+
                     if (this.ManagedIdentity.IsPresent)
                     {
-                        servicesDescription.Identity = new Management.HealthcareApis.Models.ServicesResourceIdentity() { Type = "SystemAssigned" };
+                        servicesDescription.Identity = new ServicesResourceIdentity() { Type = "SystemAssigned" };
                     }
 
                     if (!string.IsNullOrEmpty(PublicNetworkAccess))
@@ -288,6 +294,11 @@ private Kind ParseKindFromVersion(string fhirVersion)
             return CosmosOfferThroughput;
         }
 
+        private string GetCosmosDBKeyVaultKeyUri()
+        {
+            return CosmosKeyVaultKeyUri;
+        }
+
         private string GetAudience()
         {
             if (string.IsNullOrEmpty(this.Audience))

src/HealthcareApis/HealthcareApis/HealthcareApis/NewAzureRmHealthcareApisService.cs

@@ -12,16 +12,16 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
-using Microsoft.Azure.Commands.HealthcareApis.Properties;
 using Microsoft.Azure.Commands.HealthcareApis.Common;
 using Microsoft.Azure.Commands.HealthcareApis.Models;
-using Microsoft.Azure.Management.HealthcareApis;
-using System.Globalization;
-using System.Management.Automation;
+using Microsoft.Azure.Commands.HealthcareApis.Properties;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
+using Microsoft.Azure.Management.HealthcareApis;
 using Microsoft.Azure.Management.HealthcareApis.Models;
 using System;
 using System.Collections.Generic;
+using System.Globalization;
+using System.Management.Automation;
 
 namespace Microsoft.Azure.Commands.HealthcareApis.Commands
 {