New-PartnerAccessToken

Módulo:

PartnerCenter Module

Acquires an access token from Azure Active Directory.

Sintaxe

AccessToken

New-PartnerAccessToken
    -AccessToken <String>
    -ApplicationId <String>
    -Scopes <String[]>
    [-Credential <PSCredential>]
    [-Environment <EnvironmentName>]
    [-Tenant <String>]
    [<CommonParameters>]

RefreshToken

New-PartnerAccessToken
    -RefreshToken <String>
    -Scopes <String[]>
    [-ApplicationId <String>]
    [-CertificateThumbprint <String>]
    [-Credential <PSCredential>]
    [-Environment <EnvironmentName>]
    [-Module <ModuleName>]
    [-ServicePrincipal]
    [-Tenant <String>]
    [<CommonParameters>]

ServicePrincipal

New-PartnerAccessToken
    -ApplicationId <String>
    -Credential <PSCredential>
    -Scopes <String[]>
    -Tenant <String>
    [-Environment <EnvironmentName>]
    [-ServicePrincipal]
    [-UseAuthorizationCode]
    [<CommonParameters>]

ServicePrincipalCertificate

New-PartnerAccessToken
    -ApplicationId <String>
    -CertificateThumbprint <String>
    -Scopes <String[]>
    -Tenant <String>
    [-Environment <EnvironmentName>]
    [-ServicePrincipal]
    [-UseAuthorizationCode]
    [<CommonParameters>]

User

New-PartnerAccessToken
    -ApplicationId <String>
    -Scopes <String[]>
    [-Environment <EnvironmentName>]
    [-Tenant <String>]
    [-UseAuthorizationCode]
    [-UseDeviceAuthentication]
    [<CommonParameters>]

ByModule

New-PartnerAccessToken
    -Module <ModuleName>
    [-Environment <EnvironmentName>]
    [-RefreshToken <String>]
    [-Tenant <String>]
    [-UseAuthorizationCode]
    [<CommonParameters>]

Description

Acquires an access token from Azure Active Directory.

Exemplos

Example 1: Generating a new access token

PS C:\> $credential = Get-Credential
PS C:\> New-PartnerAccessToken -ApplicationId 'xxxx-xxxx-xxxx-xxxx' -Scopes 'https://api.partnercenter.microsoft.com/user_impersonation' -ServicePrincipal -Credential $credential -Tenant 'xxxx-xxxx-xxxx-xxxx' -UseAuthorizationCode

The first command gets the service principal credentials (application identifier and service principal secret), and then stores them in the $credential variable. The second command will request a new access token from Azure Active Directory. When using the UseAuthorizationCode parameter you will be prompted to authentication interactively using the authorization code flow. The redirect URI value will generated dynamically. This generation process will attempt to find a port between 8400 and 8999 that is not in use. Once an available port has been found, the redirect URL value will be constructed (e.g. http://localhost:8400). So, it is important that you have configured the redirect URI value for your Azure Active Directory application accordingly.

Example 2: Generating an access token using a refresh token

PS C:\> $credential = Get-Credential
PS C:\> $refreshToken = '<refreshToken>'
PS C:\> New-PartnerAccessToken -ApplicationId 'xxxx-xxxx-xxxx-xxxx' -Credential $credential -RefreshToken $refreshToken -Scopes 'https://api.partnercenter.microsoft.com/user_impersonation' -ServicePrincipal -Tenant 'xxxx-xxxx-xxxx-xxxx'

The first command gets the service principal credentials (application identifier and service principal secret), and then stores them in the $credential variable. The third command will generate a new access token using the service principal credentials stored in the $credential variable and the refresh token stored in the $refreshToken variable for authentication.

Parâmetros

-AccessToken

The access token for Partner Center.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

AccessToken

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-ApplicationId

The application identifier to be used during authentication.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	ClientId

Conjuntos de parâmetros

AccessToken

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

ServicePrincipal

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

ServicePrincipalCertificate

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

User

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-CertificateThumbprint

Certificate Hash (Thumbprint)

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

RefreshToken

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Credential

Credentials that represents the service principal.

Propriedades dos parâmetros

Tipo:	PSCredential
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

AccessToken

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

RefreshToken

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Environment

The environment use for authentication.

Propriedades dos parâmetros

Tipo:	EnvironmentName
Default value:	None
Valores aceites:	AzureCloud, AzureChinaCloud, AzureGermanCloud, AzurePPE, AzureUSGovernment
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	EnvironmentName

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Module

The module that an access token is being generated.

Propriedades dos parâmetros

Tipo:	ModuleName
Default value:	None
Valores aceites:	ExchangeOnline
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	ModuleName

Conjuntos de parâmetros

RefreshToken

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-RefreshToken

The refresh token to use during authentication.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

RefreshToken

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Scopes

Scopes requested to access a protected API.

Propriedades dos parâmetros

Tipo:	String[]
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

AccessToken

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

RefreshToken

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

ServicePrincipal

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

ServicePrincipalCertificate

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

User

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-ServicePrincipal

Indicates that this account authenticates by providing service principal credentials.

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

RefreshToken

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

ServicePrincipalCertificate

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Tenant

The identifier of the Azure AD tenant.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	Domain, TenantId

Conjuntos de parâmetros

AccessToken

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

RefreshToken

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

User

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

ByModule

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-UseAuthorizationCode

Use the authorization code flow during authentication.

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	AuthCode

Conjuntos de parâmetros

ServicePrincipal

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

ServicePrincipalCertificate

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

User

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

ByModule

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-UseDeviceAuthentication

Use device code authentication instead of a browser control

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	DeviceCode, DeviceAuth, Device

Conjuntos de parâmetros

User

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Entradas

None

Saídas

Microsoft.Store.PartnerCenter.PowerShell.Models.Authentication.AuthResult