次の方法で共有


DefaultAzureCredentialClientIdOptions interface

DefaultAzureCredential クラス 構成するためのオプションを提供します。 このバリエーションでは、両方の 1 つだけがサポートされているため、managedIdentityClientIdではなく、managedIdentityResourceId がサポートされます。

Extends

プロパティ

managedIdentityClientId

必要に応じて、 ManagedIdentityCredential で使用されるユーザー割り当てのクライアント ID を渡します。 このクライアント ID は、環境変数 AZURE_CLIENT_ID を使用して ManagedIdentityCredential に渡すこともできます。

workloadIdentityClientId

オプションで、 WorkloadIdentityCredential で使用されるユーザー割り当てクライアント ID を渡します。 このクライアント ID は、環境変数 AZURE_CLIENT_ID を介して WorkloadIdentityCredential に渡すこともできます。

継承されたプロパティ

additionallyAllowedTenants

マルチテナント アプリケーションの場合は、資格情報がトークンを取得できる追加のテナントを指定します。 ワイルドカード値 "*" を追加して、アプリケーションがインストールされているテナントのトークンを資格情報で取得できるようにします。

additionalPolicies

HTTP パイプラインに含める追加のポリシー。

agent

送信要求のエージェント インスタンスを構成するためのオプション

allowInsecureConnection

要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します

authorityHost

認証要求に使用する機関ホスト。 使用可能な値は、AzureAuthorityHostsを使用して使用できます。 既定値は "https://login.microsoftonline.com"です。

disableInstanceDiscovery

このフィールドは、認証を試みるときにインスタンス検出を実行するかどうかを決定します。 これを true に設定すると、インスタンスの検出と機関の検証の両方が完全に無効になります。 その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。 この機能は、プライベート クラウドや Azure Stack など、メタデータ エンドポイントに到達できないシナリオで使用することを目的としています。 インスタンス検出のプロセスでは、権限を検証するために、 https://login.microsoft.com/ から機関メタデータを取得する必要があります。

httpClient

HTTP 要求の送信に使用される HttpClient。

loggingOptions

ユーザーは、ポリシー オプションのログ記録の設定を構成したり、アカウント情報のログ記録を許可したり、カスタマー サポートのために個人を特定できる情報を許可したりできます。

processTimeoutInMs

開発者の資格情報 ( <xref:AzurePowershellCredential>、 AzureDeveloperCliCredentialAzureCliCredential) のトークン要求を行うために構成できるタイムアウト。 資格情報のプロセス タイムアウトは、ミリ秒単位で指定する必要があります。

proxyOptions

送信要求のプロキシを構成するためのオプション。

redirectOptions

リダイレクト応答の処理方法のオプション。

retryOptions

失敗した要求を再試行する方法を制御するオプション。

telemetryOptions

一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。

tenantId

必要に応じて、資格情報の一部として使用するテナント ID を渡します。 既定では、基になる資格情報に応じて汎用テナント ID が使用される場合があります。

tlsOptions

TLS 認証を構成するためのオプション

userAgentOptions

送信要求にユーザー エージェントの詳細を追加するためのオプション。

プロパティの詳細

managedIdentityClientId

必要に応じて、 ManagedIdentityCredential で使用されるユーザー割り当てのクライアント ID を渡します。 このクライアント ID は、環境変数 AZURE_CLIENT_ID を使用して ManagedIdentityCredential に渡すこともできます。

managedIdentityClientId?: string

プロパティ値

string

workloadIdentityClientId

オプションで、 WorkloadIdentityCredential で使用されるユーザー割り当てクライアント ID を渡します。 このクライアント ID は、環境変数 AZURE_CLIENT_ID を介して WorkloadIdentityCredential に渡すこともできます。

workloadIdentityClientId?: string

プロパティ値

string

継承されたプロパティの詳細

additionallyAllowedTenants

マルチテナント アプリケーションの場合は、資格情報がトークンを取得できる追加のテナントを指定します。 ワイルドカード値 "*" を追加して、アプリケーションがインストールされているテナントのトークンを資格情報で取得できるようにします。

additionallyAllowedTenants?: string[]

プロパティ値

string[]

DefaultAzureCredentialOptions.additionallyAllowedTenantsから継承されます

additionalPolicies

HTTP パイプラインに含める追加のポリシー。

additionalPolicies?: AdditionalPolicyConfig[]

プロパティ値

承元DefaultAzureCredentialOptions.additionalPolicies

agent

送信要求のエージェント インスタンスを構成するためのオプション

agent?: Agent

プロパティ値

承元DefaultAzureCredentialOptions.agent

allowInsecureConnection

要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します

allowInsecureConnection?: boolean

プロパティ値

boolean

DefaultAzureCredentialOptions.allowInsecureConnectionから継承

authorityHost

認証要求に使用する機関ホスト。 使用可能な値は、AzureAuthorityHostsを使用して使用できます。 既定値は "https://login.microsoftonline.com"です。

authorityHost?: string

プロパティ値

string

承元DefaultAzureCredentialOptions.authorityHost

disableInstanceDiscovery

このフィールドは、認証を試みるときにインスタンス検出を実行するかどうかを決定します。 これを true に設定すると、インスタンスの検出と機関の検証の両方が完全に無効になります。 その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。 この機能は、プライベート クラウドや Azure Stack など、メタデータ エンドポイントに到達できないシナリオで使用することを目的としています。 インスタンス検出のプロセスでは、権限を検証するために、 https://login.microsoft.com/ から機関メタデータを取得する必要があります。

disableInstanceDiscovery?: boolean

プロパティ値

boolean

承元DefaultAzureCredentialOptions.disableInstanceDiscovery

httpClient

HTTP 要求の送信に使用される HttpClient。

httpClient?: HttpClient

プロパティ値

DefaultAzureCredentialOptions.httpClientから継承

loggingOptions

ユーザーは、ポリシー オプションのログ記録の設定を構成したり、アカウント情報のログ記録を許可したり、カスタマー サポートのために個人を特定できる情報を許可したりできます。

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

プロパティ値

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

DefaultAzureCredentialOptions.loggingOptionsから継承

processTimeoutInMs

開発者の資格情報 ( <xref:AzurePowershellCredential>、 AzureDeveloperCliCredentialAzureCliCredential) のトークン要求を行うために構成できるタイムアウト。 資格情報のプロセス タイムアウトは、ミリ秒単位で指定する必要があります。

processTimeoutInMs?: number

プロパティ値

number

承元DefaultAzureCredentialOptions.processTimeoutInMs

proxyOptions

送信要求のプロキシを構成するためのオプション。

proxyOptions?: ProxySettings

プロパティ値

承元DefaultAzureCredentialOptions.proxyOptions

redirectOptions

リダイレクト応答の処理方法のオプション。

redirectOptions?: RedirectPolicyOptions

プロパティ値

DefaultAzureCredentialOptions.redirectOptionsから継承

retryOptions

失敗した要求を再試行する方法を制御するオプション。

retryOptions?: PipelineRetryOptions

プロパティ値

承元DefaultAzureCredentialOptions.retryOptions

telemetryOptions

一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。

telemetryOptions?: TelemetryOptions

プロパティ値

承元DefaultAzureCredentialOptions.telemetryOptions

tenantId

必要に応じて、資格情報の一部として使用するテナント ID を渡します。 既定では、基になる資格情報に応じて汎用テナント ID が使用される場合があります。

tenantId?: string

プロパティ値

string

DefaultAzureCredentialOptions.tenantIdから継承

tlsOptions

TLS 認証を構成するためのオプション

tlsOptions?: TlsSettings

プロパティ値

DefaultAzureCredentialOptions.tlsOptionsから継承

userAgentOptions

送信要求にユーザー エージェントの詳細を追加するためのオプション。

userAgentOptions?: UserAgentPolicyOptions

プロパティ値

DefaultAzureCredentialOptions.userAgentOptionsから継承