AzurePipelinesCredential class
この資格情報は、ワークロード ID フェデレーションのセットアップとしてサービス接続を使用する Azure Pipelines で使用するように設計されています。
コンストラクター
| Azure |
AzurePipelinesCredential では、サービス接続を介した Azure Pipelines でのフェデレーション ID がサポートされます。 |
メソッド
| get |
Microsoft Entra ID を使用して認証し、成功した場合はアクセス トークンを返します。 認証に失敗した場合、CredentialUnavailableError または AuthenticationError がスローされ、エラーの詳細が表示されます。 |
コンストラクターの詳細
AzurePipelinesCredential(string, string, string, string, AzurePipelinesCredentialOptions)
AzurePipelinesCredential では、サービス接続を介した Azure Pipelines でのフェデレーション ID がサポートされます。
new AzurePipelinesCredential(tenantId: string, clientId: string, serviceConnectionId: string, systemAccessToken: string, options?: AzurePipelinesCredentialOptions)パラメーター
- tenantId
-
string
サービス接続に関連付けられている tenantId
- clientId
-
string
サービス接続に関連付けられている clientId
- serviceConnectionId
-
string
querystring の resourceId キーにあるサービス接続の一意の ID
- systemAccessToken
-
string
パイプラインの System.AccessToken 値。
- options
- AzurePipelinesCredentialOptions
認証に使用する ID クライアント オプション。
メソッドの詳細
getToken(string | string[], GetTokenOptions)
Microsoft Entra ID を使用して認証し、成功した場合はアクセス トークンを返します。 認証に失敗した場合、CredentialUnavailableError または AuthenticationError がスローされ、エラーの詳細が表示されます。
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>パラメーター
- scopes
-
string | string[]
トークンがアクセスできるスコープの一覧。
- options
- GetTokenOptions
この TokenCredential 実装が行う可能性がある要求を構成するために使用されるオプション。
戻り値
Promise<AccessToken>