AzurePipelinesCredential class
この資格は、Azure Pipelinesでサービス接続と共にワークロードアイデンティティフェデレーションのセットアップとして使用されるように設計されています。
コンストラクター
| Azure |
AzurePipelinesCredentialはサービス接続を通じてAzure PipelinesのFederated Identityをサポートしています。 |
メソッド
| get |
Microsoft Entra IDで認証し、成功するとアクセストークンを返します。 認証に失敗した場合、CredentialUnavailableError または AuthenticationError がスローされ、エラーの詳細が表示されます。 |
コンストラクターの詳細
AzurePipelinesCredential(string, string, string, string, AzurePipelinesCredentialOptions)
AzurePipelinesCredentialはサービス接続を通じてAzure PipelinesのFederated Identityをサポートしています。
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
パイプラインの <参照 href="https://learn.microsoft.com/azure/devops/pipelines/build/variables?view=azure-devops%26tabs=yaml#systemaccesstoken">System.AccessToken</see> 値。
- 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>