ApplicationTokenCertificateCredentials class
- Extends
-
ApplicationTokenCredentialsBase
コンストラクター
| Application |
新しい ApplicationTokenCredentials オブジェクトを作成します。 Azure Active Directory アプリケーション 作成する方法の詳細については、.Net の Active Directory クイック スタートを参照してください。 |
プロパティ
| certificate | |
| thumbprint |
継承されたプロパティ
| auth |
|
| client |
|
| domain | |
| environment | |
| token |
|
| token |
メソッド
| create(string, string, string, Azure |
ApplicationTokenCertificateCredentials の新しいインスタンスを作成します。 |
| get |
最初にキャッシュからトークンを取得しようとします。 失敗した場合は、ADAL からトークンを取得しようとします。 |
継承されたメソッド
| set |
|
| sign |
Authentication ヘッダーを使用して要求に署名します。 |
コンストラクターの詳細
ApplicationTokenCertificateCredentials(string, string, string, string, TokenAudience, Environment, TokenCache)
新しい ApplicationTokenCredentials オブジェクトを作成します。 Azure Active Directory アプリケーション 作成する方法の詳細については、.Net の Active Directory クイック スタートを参照してください。
new ApplicationTokenCertificateCredentials(clientId: string, domain: string, certificate: string, thumbprint: string, tokenAudience?: TokenAudience, environment?: Environment, tokenCache?: TokenCache)
パラメーター
- clientId
-
string
Active Directory アプリケーション クライアント ID。
- domain
-
string
このアプリケーションを含むドメインまたはテナント ID。
- certificate
-
string
PEM でエンコードされた証明書の秘密キー。
- thumbprint
-
string
証明書の 16 進エンコード拇印。
- tokenAudience
- TokenAudience
トークンが要求される対象ユーザー。 有効な値は、'graph'、'batch'、または 'https://vault.azure.net/' のような他のリソースです。 tokenAudience が 'graph' の場合は、ドメインも指定する必要があり、その値は既定の "共通" テナントにすることはできません。 文字列である必要があります (好ましくは guid 形式)。
- environment
- Environment
認証に使用する Azure 環境。
- tokenCache
-
TokenCache
トークン キャッシュ。 既定値は、adal の MemoryCache オブジェクトです。
プロパティの詳細
certificate
certificate: string
プロパティ値
string
thumbprint
thumbprint: string
プロパティ値
string
継承されたプロパティの詳細
authContext
authContext: AuthenticationContext
プロパティ値
AuthenticationContext
ApplicationTokenCredentialsBase.authContext から継承された
clientId
clientId: string
プロパティ値
string
ApplicationTokenCredentialsBase.clientId から継承された
domain
domain: string
プロパティ値
string
ApplicationTokenCredentialsBase.domain から継承された
environment
tokenAudience
tokenAudience?: string
プロパティ値
string
ApplicationTokenCredentialsBase.tokenAudience から継承された
tokenCache
tokenCache: TokenCache
プロパティ値
TokenCache
applicationTokenCredentialsBase.tokenCache から継承
メソッドの詳細
create(string, string, string, AzureTokenCredentialsOptions)
ApplicationTokenCertificateCredentials の新しいインスタンスを作成します。
static function create(clientId: string, certificateStringOrFilePath: string, domain: string, options: AzureTokenCredentialsOptions): ApplicationTokenCertificateCredentials
パラメーター
- clientId
-
string
ACTIVE Directory アプリケーション クライアント ID は SPN (ServicePrincipal Name) とも呼ばれます。 例については、「Active Directory クイック スタート for .Net」を参照してください。
- certificateStringOrFilePath
-
string
PEM でエンコードされた証明書と秘密キー、またはその情報を含む .pem ファイルへの絶対ファイルパス。 例えば:
- CertificateString: "-----BEGIN PRIVATE KEY-----\n<XXXXX>\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n<yyy>\n-----END CERTIFICATE-----\n"
- CertificateFilePath: .pem ファイルの絶対 ファイル パスを します。
- domain
-
string
このアプリケーションを含むドメインまたはテナント ID。
- options
- AzureTokenCredentialsOptions
AzureTokenCredentialsOptions - 省略可能なパラメーターを表すオブジェクト。
戻り値
ApplicationTokenCertificateCredentials
getToken()
最初にキャッシュからトークンを取得しようとします。 失敗した場合は、ADAL からトークンを取得しようとします。
function getToken(): Promise<TokenResponse>
戻り値
Promise<TokenResponse>
TokenResponse に解決され、エラーで拒否される Promise。
継承済みメソッドの詳細
setDomain(string)
function setDomain(domain: string)
パラメーター
- domain
-
string
ApplicationTokenCredentialsBase.setDomain から継承された
signRequest(WebResource)
Authentication ヘッダーを使用して要求に署名します。
function signRequest(webResource: WebResource): Promise<WebResource>
パラメーター
- webResource
- WebResource
署名する WebResource。
戻り値
Promise<WebResource>
ApplicationTokenCredentialsBase.signRequest から継承された