ClientSecretCredentialOptions interface
ClientSecretCredential クラスの省略可能なパラメーター。
- Extends
継承されたプロパティ
additionally |
マルチテナント アプリケーションの場合は、資格情報がトークンを取得できる追加のテナントを指定します。 ワイルドカード値 "*" を追加して、アプリケーションがインストールされている任意のテナントのトークンを資格情報で取得できるようにします。 |
additional |
HTTP パイプラインに含める追加のポリシー。 |
allow |
要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します |
authority |
認証要求に使用する機関ホスト。 使用可能な値は、 AzureAuthorityHosts を使用して使用できます。 既定値は "https://login.microsoftonline.com" です。 |
disable |
フィールドは、認証を試みるときにインスタンス検出を実行するかどうかを決定します。
これを に |
http |
HTTP 要求の送信に使用される HttpClient。 |
logging |
ユーザーは、ログ ポリシー オプションの設定を構成し、顧客サポートのアカウント情報と個人を特定できる情報をログに記録できるようにします。 |
proxy |
送信要求のプロキシを構成するためのオプション。 |
redirect |
リダイレクト応答の処理方法のオプション。 |
retry |
失敗した要求を再試行する方法を制御するオプション。 |
telemetry |
一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。 |
tls |
TLS 認証を構成するためのオプション |
token |
資格情報を格納するときに永続化レイヤーに提供するオプション (使用可能な場合)。 最初に永続化プロバイダー プラグインを登録する必要があります。 NPM の 例:
|
user |
送信要求にユーザー エージェントの詳細を追加するためのオプション。 |
継承されたプロパティの詳細
additionallyAllowedTenants
マルチテナント アプリケーションの場合は、資格情報がトークンを取得できる追加のテナントを指定します。 ワイルドカード値 "*" を追加して、アプリケーションがインストールされている任意のテナントのトークンを資格情報で取得できるようにします。
additionallyAllowedTenants?: string[]
プロパティ値
string[]
MultiTenantTokenCredentialOptions.additionallyAllowedTenantsから継承されます
additionalPolicies
HTTP パイプラインに含める追加のポリシー。
additionalPolicies?: AdditionalPolicyConfig[]
プロパティ値
allowInsecureConnection
要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します
allowInsecureConnection?: boolean
プロパティ値
boolean
MultiTenantTokenCredentialOptions.allowInsecureConnectionから継承
authorityHost
認証要求に使用する機関ホスト。 使用可能な値は、 AzureAuthorityHosts を使用して使用できます。 既定値は "https://login.microsoftonline.com" です。
authorityHost?: string
プロパティ値
string
disableInstanceDiscovery
フィールドは、認証を試みるときにインスタンス検出を実行するかどうかを決定します。
これを に true
設定すると、インスタンスの検出と機関の検証の両方が完全に無効になります。
その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。
この機能は、プライベート クラウドや Azure Stack など、メタデータ エンドポイントに到達できないシナリオでの使用を目的としています。
インスタンス検出のプロセスでは、 から https://login.microsoft.com/ 機関メタデータを取得して機関を検証する必要があります。
disableInstanceDiscovery?: boolean
プロパティ値
boolean
httpClient
HTTP 要求の送信に使用される HttpClient。
httpClient?: HttpClient
プロパティ値
loggingOptions
ユーザーは、ログ ポリシー オプションの設定を構成し、顧客サポートのアカウント情報と個人を特定できる情報をログに記録できるようにします。
loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
プロパティ値
LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
proxyOptions
送信要求のプロキシを構成するためのオプション。
proxyOptions?: ProxySettings
プロパティ値
redirectOptions
リダイレクト応答の処理方法のオプション。
redirectOptions?: RedirectPolicyOptions
プロパティ値
retryOptions
失敗した要求を再試行する方法を制御するオプション。
retryOptions?: PipelineRetryOptions
プロパティ値
telemetryOptions
一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。
telemetryOptions?: TelemetryOptions
プロパティ値
tlsOptions
TLS 認証を構成するためのオプション
tlsOptions?: TlsSettings
プロパティ値
tokenCachePersistenceOptions
資格情報を格納するときに永続化レイヤーに提供するオプション (使用可能な場合)。
最初に永続化プロバイダー プラグインを登録する必要があります。 NPM の @azure/identity-cache-persistence
パッケージを参照してください。
例:
import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);
async function main() {
const credential = new DeviceCodeCredential({
tokenCachePersistenceOptions: {
enabled: true
}
});
}
main().catch((error) => {
console.error("An error occurred:", error);
process.exit(1);
});
tokenCachePersistenceOptions?: TokenCachePersistenceOptions
プロパティ値
CredentialPersistenceOptions.tokenCachePersistenceOptionsから継承
userAgentOptions
送信要求にユーザー エージェントの詳細を追加するためのオプション。
userAgentOptions?: UserAgentPolicyOptions