From 75beefac0076382058a5d0fa7b0f42d8b7363f48 Mon Sep 17 00:00:00 2001 From: Christopher Scott Date: Thu, 28 Jan 2021 11:26:24 -0600 Subject: [PATCH 1/3] tweaks to New-TestResources readme --- eng/common/TestResources/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/eng/common/TestResources/README.md b/eng/common/TestResources/README.md index 2e2d72c9b52b5..da16782e7ded4 100644 --- a/eng/common/TestResources/README.md +++ b/eng/common/TestResources/README.md @@ -30,7 +30,7 @@ Connect-AzAccount -Subscription 'YOUR SUBSCRIPTION ID' eng\common\TestResources\New-TestResources.ps1 -ServiceDirectory 'search' ``` -The `OutFile` switch would be set if you are running this for a .NET project on Windows. This will save test environment settings +The `OutFile` switch should be set if you are running this for a .NET project on Windows. This will save test environment settings into a test-resources.json.env file next to test-resources.json. The file is protected via DPAPI. The environment file would be scoped to the current repository directory and avoids the need to set environment variables or restart your IDE to recognize them. @@ -89,6 +89,12 @@ Remove-AzADServicePrincipal -ApplicationId $sp.ApplicationId -Force If you persisted environment variables, you should also remove those as well. +Some scripts accept the `AdditionalParameters` parameter to control additional resource configuration options. For example: + +```powershell +.\eng\common\TestResources\New-TestResources.ps1 keyvault -AdditionalParameters @{enableHsm = $true} +``` + ## In CI Test pipelines should include deploy-test-resources.yml and From 84a11391db193e7470b79dff7bf39975315ebcb3 Mon Sep 17 00:00:00 2001 From: Christopher Scott Date: Fri, 29 Jan 2021 10:01:58 -0600 Subject: [PATCH 2/3] tweaks --- eng/common/TestResources/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/eng/common/TestResources/README.md b/eng/common/TestResources/README.md index da16782e7ded4..f3524a5b99248 100644 --- a/eng/common/TestResources/README.md +++ b/eng/common/TestResources/README.md @@ -30,7 +30,7 @@ Connect-AzAccount -Subscription 'YOUR SUBSCRIPTION ID' eng\common\TestResources\New-TestResources.ps1 -ServiceDirectory 'search' ``` -The `OutFile` switch should be set if you are running this for a .NET project on Windows. This will save test environment settings +The `OutFile` switch will be set by default if you are running this for a .NET project on Windows. This will save test environment settings into a test-resources.json.env file next to test-resources.json. The file is protected via DPAPI. The environment file would be scoped to the current repository directory and avoids the need to set environment variables or restart your IDE to recognize them. @@ -92,7 +92,7 @@ If you persisted environment variables, you should also remove those as well. Some scripts accept the `AdditionalParameters` parameter to control additional resource configuration options. For example: ```powershell -.\eng\common\TestResources\New-TestResources.ps1 keyvault -AdditionalParameters @{enableHsm = $true} +New-TestResources.ps1 keyvault -AdditionalParameters @{enableHsm = $true} ``` ## In CI From 7eb9d62c9dce887aae680eacecd958bcded54827 Mon Sep 17 00:00:00 2001 From: Christopher Scott Date: Fri, 29 Jan 2021 15:06:53 -0600 Subject: [PATCH 3/3] prc --- eng/common/TestResources/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eng/common/TestResources/README.md b/eng/common/TestResources/README.md index f3524a5b99248..3aa1720107e31 100644 --- a/eng/common/TestResources/README.md +++ b/eng/common/TestResources/README.md @@ -89,7 +89,7 @@ Remove-AzADServicePrincipal -ApplicationId $sp.ApplicationId -Force If you persisted environment variables, you should also remove those as well. -Some scripts accept the `AdditionalParameters` parameter to control additional resource configuration options. For example: +Some test-resources.json templates utilize the `AdditionalParameters` parameter to control additional resource configuration options. For example: ```powershell New-TestResources.ps1 keyvault -AdditionalParameters @{enableHsm = $true}