Skip to content

Commit efc3945

Browse files
danieljurekazure-sdk
authored andcommitted
Update docs
1 parent 79837f3 commit efc3945

File tree

2 files changed

+12
-35
lines changed

2 files changed

+12
-35
lines changed

eng/common/TestResources/New-TestResources.ps1.md

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ New-TestResources.ps1 [-BaseName <String>] [-ResourceGroupName <String>] [-Servi
1919
[-TestApplicationOid <String>] [-SubscriptionId <String>] [-DeleteAfterHours <Int32>] [-Location <String>]
2020
[-Environment <String>] [-ResourceType <String>] [-ArmTemplateParameters <Hashtable>]
2121
[-AdditionalParameters <Hashtable>] [-EnvironmentVariables <Hashtable>] [-CI] [-Force] [-OutFile]
22-
[-SuppressVsoCommands] [-ServicePrincipalAuth] [-FederatedAuth] [-NewTestResourcesRemainingArguments <Object>]
22+
[-SuppressVsoCommands] [-ServicePrincipalAuth] [-NewTestResourcesRemainingArguments <Object>]
2323
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
2424
```
2525

@@ -32,7 +32,7 @@ New-TestResources.ps1 [-BaseName <String>] [-ResourceGroupName <String>] [-Servi
3232
-ProvisionerApplicationSecret <String> [-DeleteAfterHours <Int32>] [-Location <String>]
3333
[-Environment <String>] [-ResourceType <String>] [-ArmTemplateParameters <Hashtable>]
3434
[-AdditionalParameters <Hashtable>] [-EnvironmentVariables <Hashtable>] [-CI] [-Force] [-OutFile]
35-
[-SuppressVsoCommands] [-ServicePrincipalAuth] [-FederatedAuth] [-NewTestResourcesRemainingArguments <Object>]
35+
[-SuppressVsoCommands] [-ServicePrincipalAuth] [-NewTestResourcesRemainingArguments <Object>]
3636
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
3737
```
3838

@@ -630,31 +630,10 @@ Accept wildcard characters: False
630630
```
631631
632632
### -ServicePrincipalAuth
633-
Use the signed in user's credentials to create a service principal for
634-
provisioning.
635-
This is useful for some local development scenarios.
636-
637-
```yaml
638-
Type: SwitchParameter
639-
Parameter Sets: (All)
640-
Aliases:
641-
642-
Required: False
643-
Position: Named
644-
Default value: False
645-
Accept pipeline input: False
646-
Accept wildcard characters: False
647-
```
648-
649-
### -FederatedAuth
650-
Use signed in user's credentials for provisioninig.
651-
No service principal will be
652-
created.
653-
This is used in CI where the execution context already has a signed in
654-
user.
655-
656-
In cases where provisioner or test applications are specified, secrets for those
657-
apps will not be exported or made available to pre- or post- scripts.
633+
Use the provisioner SP credentials to deploy, and pass the test SP credentials
634+
to tests.
635+
If provisioner and test SP are not set, provision an SP with user
636+
credentials and pass the new SP to tests.
658637
659638
```yaml
660639
Type: SwitchParameter

eng/common/TestResources/Remove-TestResources.ps1.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Deletes the resource group deployed for a service directory from Azure.
1515
### Default (Default)
1616
```
1717
Remove-TestResources.ps1 [-BaseName <String>] [-SubscriptionId <String>] [[-ServiceDirectory] <String>]
18-
[-Environment <String>] [-ResourceType <String>] [-FederatedAuth] [-Force]
18+
[-Environment <String>] [-ResourceType <String>] [-ServicePrincipalAuth] [-Force]
1919
[-RemoveTestResourcesRemainingArguments <Object>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
2020
[<CommonParameters>]
2121
```
@@ -24,7 +24,7 @@ Remove-TestResources.ps1 [-BaseName <String>] [-SubscriptionId <String>] [[-Serv
2424
```
2525
Remove-TestResources.ps1 -BaseName <String> -TenantId <String> [-SubscriptionId <String>]
2626
-ProvisionerApplicationId <String> -ProvisionerApplicationSecret <String> [[-ServiceDirectory] <String>]
27-
[-Environment <String>] [-ResourceType <String>] [-FederatedAuth] [-Force]
27+
[-Environment <String>] [-ResourceType <String>] [-ServicePrincipalAuth] [-Force]
2828
[-RemoveTestResourcesRemainingArguments <Object>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
2929
[<CommonParameters>]
3030
```
@@ -33,15 +33,15 @@ Remove-TestResources.ps1 -BaseName <String> -TenantId <String> [-SubscriptionId
3333
```
3434
Remove-TestResources.ps1 [-ResourceGroupName <String>] -TenantId <String> [-SubscriptionId <String>]
3535
-ProvisionerApplicationId <String> -ProvisionerApplicationSecret <String> [[-ServiceDirectory] <String>]
36-
[-Environment <String>] [-CI] [-ResourceType <String>] [-FederatedAuth] [-Force]
36+
[-Environment <String>] [-CI] [-ResourceType <String>] [-ServicePrincipalAuth] [-Force]
3737
[-RemoveTestResourcesRemainingArguments <Object>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
3838
[<CommonParameters>]
3939
```
4040

4141
### ResourceGroup
4242
```
4343
Remove-TestResources.ps1 [-ResourceGroupName <String>] [-SubscriptionId <String>]
44-
[[-ServiceDirectory] <String>] [-Environment <String>] [-CI] [-ResourceType <String>] [-FederatedAuth]
44+
[[-ServiceDirectory] <String>] [-Environment <String>] [-CI] [-ResourceType <String>] [-ServicePrincipalAuth]
4545
[-Force] [-RemoveTestResourcesRemainingArguments <Object>] [-ProgressAction <ActionPreference>] [-WhatIf]
4646
[-Confirm] [<CommonParameters>]
4747
```
@@ -255,10 +255,8 @@ Accept pipeline input: False
255255
Accept wildcard characters: False
256256
```
257257
258-
### -FederatedAuth
259-
Use signed in user's credentials for provisioninig.
260-
This is used in CI where
261-
the execution context already has a signed in user.
258+
### -ServicePrincipalAuth
259+
Log in with provided Provisioner application credentials.
262260
263261
```yaml
264262
Type: SwitchParameter

0 commit comments

Comments
 (0)