New-PartnerAccessToken
Azure Active Directory からアクセス トークンを取得します。
構文
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>]
説明
Azure Active Directory からアクセス トークンを取得します。
例
例 1: 新しいアクセストークンの生成
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
最初のコマンドは、サービス プリンシパルの資格情報 (アプリケーション識別子とサービス プリンシパル シークレット) を取得し、それらを $credential 変数に格納します。 2 番目のコマンドは、Azure Active Directory から新しいアクセス トークンを要求します。
UseAuthorizationCode パラメーターを使用すると、認証コード フローを使用して対話形式で認証するように求められます。 リダイレクト URI 値は動的に生成されます。 この生成プロセスでは、使用されていない 8400 から 8999 までのポートの検索が試みられます。 利用可能なポートが見つかると、リダイレクトURL値が構築されます(例: http://localhost:8400)。 そのため、Azure Active Directory アプリケーションのリダイレクト URI 値を適宜構成しておくことが重要です。
例 2: 更新トークンを使用したアクセス トークンの生成
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'
最初のコマンドは、サービス プリンシパルの資格情報 (アプリケーション識別子とサービス プリンシパル シークレット) を取得し、それらを $credential 変数に格納します。 3 番目のコマンドは、$credential 変数に格納されているサービス プリンシパル資格情報と、認証用の $refreshToken 変数に格納されている更新トークンを使用して、新しいアクセス トークンを生成します。
パラメーター
-AccessToken
パートナー センターのアクセス トークン。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AccessToken
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ApplicationId
認証中に使用されるアプリケーション識別子。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ClientId |
パラメーター セット
AccessToken
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ServicePrincipal
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ServicePrincipalCertificate
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
User
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CertificateThumbprint
証明書ハッシュ (拇印)
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
RefreshToken
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Credential
サービス プリンシパルを表す資格情報。
パラメーターのプロパティ
| 型: | PSCredential
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AccessToken
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
RefreshToken
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Environment
認証に使用する環境。
パラメーターのプロパティ
| 型: | EnvironmentName
|
| 規定値: | None |
| 指定可能な値: | AzureCloud, AzureChinaCloud, AzureGermanCloud, AzurePPE, AzureUSGovernment |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | EnvironmentName |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Module
アクセストークンが生成されているモジュール。
パラメーターのプロパティ
| 型: | ModuleName
|
| 規定値: | None |
| 指定可能な値: | ExchangeOnline |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ModuleName |
パラメーター セット
RefreshToken
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RefreshToken
認証中に使用する更新トークン。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
RefreshToken
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Scopes
保護された API にアクセスするために要求されたスコープ。
パラメーターのプロパティ
| 型: | String[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AccessToken
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
RefreshToken
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ServicePrincipal
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ServicePrincipalCertificate
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
User
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ServicePrincipal
このアカウントがサービス プリンシパルの資格情報を指定して認証されることを示します。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
RefreshToken
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ServicePrincipalCertificate
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Tenant
Azure AD テナントの識別子。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ドメイン, テナント識別子 |
パラメーター セット
AccessToken
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
RefreshToken
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
User
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ByModule
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UseAuthorizationCode
認証中に認証コードフローを使用します。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | 認証コード |
パラメーター セット
ServicePrincipal
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ServicePrincipalCertificate
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
User
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ByModule
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UseDeviceAuthentication
ブラウザー コントロールの代わりにデバイス コード認証を使用する
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | DeviceCode, DeviceAuth, デバイス |
パラメーター セット
User
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
None
出力
Microsoft.Store.PartnerCenter.PowerShell.Models.Authentication.AuthResult