Skip to content
This repository was archived by the owner on Jul 22, 2024. It is now read-only.

Commit 48743f6

Browse files
author
Isaiah Williams
authored
Updating the documentation (#219)
1 parent 6af4d66 commit 48743f6

4 files changed

Lines changed: 44 additions & 14 deletions

File tree

azure-pipelines.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,14 @@ steps:
7575
PoliCheck: true
7676
condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT'))
7777

78+
- task: UseDotNet@2
79+
displayName: 'Use .NET Core 2.2'
80+
inputs:
81+
packageType: sdk
82+
version: 2.2.x
83+
installationPath: $(Agent.ToolsDirectory)/dotnet
84+
condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT'), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
85+
7886
- task: SFP.build-tasks.custom-build-task-1.EsrpCodeSigning@1
7987
displayName: 'ESRP code signing'
8088
inputs:

docs/help/New-PartnerAccessToken.md

Lines changed: 34 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ New-PartnerAccessToken -AccessToken <String> -ApplicationId <String> [-Credentia
2121
[-UseAuthorizationCode] [<CommonParameters>]
2222
```
2323

24-
### ServicePrincipalCertificate
24+
### ServicePrincipal
2525
```powershell
26-
New-PartnerAccessToken -ApplicationId <String> -CertificateThumbprint <String> [-Environment <EnvironmentName>]
26+
New-PartnerAccessToken -ApplicationId <String> -Credential <PSCredential> [-Environment <EnvironmentName>]
2727
[-RefreshToken <String>] -Scopes <String[]> [-ServicePrincipal] -Tenant <String> [-UseAuthorizationCode]
2828
[<CommonParameters>]
2929
```
3030

31-
### ServicePrincipal
31+
### ServicePrincipalCertificate
3232
```powershell
33-
New-PartnerAccessToken -ApplicationId <String> -Credential <PSCredential> [-Environment <EnvironmentName>]
33+
New-PartnerAccessToken -ApplicationId <String> -CertificateThumbprint <String> [-Environment <EnvironmentName>]
3434
[-RefreshToken <String>] -Scopes <String[]> [-ServicePrincipal] -Tenant <String> [-UseAuthorizationCode]
3535
[<CommonParameters>]
3636
```
@@ -41,6 +41,12 @@ New-PartnerAccessToken -ApplicationId <String> [-Environment <EnvironmentName>]
4141
-Scopes <String[]> [-Tenant <String>] [-UseAuthorizationCode] [-UseDeviceAuthentication] [<CommonParameters>]
4242
```
4343

44+
### ByModule
45+
```powershell
46+
New-PartnerAccessToken [-Environment <EnvironmentName>] -Module <ModuleName> [-RefreshToken <String>]
47+
[-Tenant <String>] [-UseAuthorizationCode] [<CommonParameters>]
48+
```
49+
4450
## DESCRIPTION
4551
Acquires an access token from Azure Active Directory.
4652

@@ -87,7 +93,7 @@ The application identifier to be used during authentication.
8793
8894
```yaml
8995
Type: String
90-
Parameter Sets: (All)
96+
Parameter Sets: AccessToken, ServicePrincipal, ServicePrincipalCertificate, User
9197
Aliases: ClientId
9298

9399
Required: True
@@ -155,6 +161,22 @@ Accept pipeline input: False
155161
Accept wildcard characters: False
156162
```
157163
164+
### -Module
165+
The module that an access token is being generated.
166+
167+
```yaml
168+
Type: ModuleName
169+
Parameter Sets: ByModule
170+
Aliases: ModuleName
171+
Accepted values: ExchangeOnline
172+
173+
Required: True
174+
Position: Named
175+
Default value: None
176+
Accept pipeline input: False
177+
Accept wildcard characters: False
178+
```
179+
158180
### -RefreshToken
159181
The refresh token to use during authentication.
160182
@@ -175,7 +197,7 @@ Scopes requested to access a protected API.
175197
176198
```yaml
177199
Type: String[]
178-
Parameter Sets: (All)
200+
Parameter Sets: AccessToken, ServicePrincipal, ServicePrincipalCertificate, User
179201
Aliases:
180202

181203
Required: True
@@ -190,10 +212,10 @@ Indicates that this account authenticates by providing service principal credent
190212
191213
```yaml
192214
Type: SwitchParameter
193-
Parameter Sets: ServicePrincipalCertificate
215+
Parameter Sets: ServicePrincipal
194216
Aliases:
195217

196-
Required: False
218+
Required: True
197219
Position: Named
198220
Default value: None
199221
Accept pipeline input: False
@@ -202,10 +224,10 @@ Accept wildcard characters: False
202224
203225
```yaml
204226
Type: SwitchParameter
205-
Parameter Sets: ServicePrincipal
227+
Parameter Sets: ServicePrincipalCertificate
206228
Aliases:
207229

208-
Required: True
230+
Required: False
209231
Position: Named
210232
Default value: None
211233
Accept pipeline input: False
@@ -217,7 +239,7 @@ The identifier of the Azure AD tenant.
217239
218240
```yaml
219241
Type: String
220-
Parameter Sets: AccessToken, User
242+
Parameter Sets: AccessToken, User, ByModule
221243
Aliases: Domain, TenantId
222244

223245
Required: False
@@ -229,7 +251,7 @@ Accept wildcard characters: False
229251
230252
```yaml
231253
Type: String
232-
Parameter Sets: ServicePrincipalCertificate, ServicePrincipal
254+
Parameter Sets: ServicePrincipal, ServicePrincipalCertificate
233255
Aliases: Domain, TenantId
234256

235257
Required: True

docs/help/PartnerCenter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ Confirms the customer acceptance of the Microsoft Cloud agreement.
267267
Creates a new application consent for the specified customer.
268268

269269
### [New-PartnerCustomerCart](New-PartnerCustomerCart.md)
270-
Creates an order for a customer.
270+
Creates a cart for a customer.
271271

272272
### [New-PartnerCustomerConfigurationPolicy](New-PartnerCustomerConfigurationPolicy.md)
273273
Creates a new configuration policy for the specified customer.

src/PowerShell/Commands/NewPartnerAccessToken.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ public class NewPartnerAccessToken : PartnerAsyncCmdlet
109109
[Parameter(HelpMessage = "Scopes requested to access a protected API.", Mandatory = true, ParameterSetName = AccessTokenParameterSet)]
110110
[Parameter(HelpMessage = "Scopes requested to access a protected API.", Mandatory = true, ParameterSetName = ServicePrincipalParameterSet)]
111111
[Parameter(HelpMessage = "Scopes requested to access a protected API.", Mandatory = true, ParameterSetName = ServicePrincipalCertificateParameterSet)]
112-
[Parameter(HelpMessage = "Scopes requested to access a protected API.", Mandatory = false, ParameterSetName = UserParameterSet)]
112+
[Parameter(HelpMessage = "Scopes requested to access a protected API.", Mandatory = true, ParameterSetName = UserParameterSet)]
113113
public string[] Scopes { get; set; }
114114

115115
/// <summary>

0 commit comments

Comments
 (0)