Share via

ClientSecretCredentialOptions interface

  • Riferimento
Pacchetto:
@azure/identity

Parametri facoltativi per la classe ClientSecretCredential .

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

Proprietà ereditate

additionallyAllowedTenants

Per le applicazioni multi-tenant, specifica tenant aggiuntivi per i quali le credenziali possono acquisire i token. Aggiungere il valore jolly "*" per consentire alle credenziali di acquisire i token per qualsiasi tenant in cui è installata l'applicazione.
additionalPolicies

Criteri aggiuntivi da includere nella pipeline HTTP.
allowInsecureConnection

Impostare su true se la richiesta viene inviata tramite HTTP anziché HTTPS
authorityHost

Host dell'autorità da usare per le richieste di autenticazione. I valori possibili sono disponibili tramite AzureAuthorityHosts. Il valore predefinito è "https://login.microsoftonline.com".
disableInstanceDiscovery

Il campo determina se l'individuazione dell'istanza viene eseguita quando si tenta di eseguire l'autenticazione. L'impostazione di questa opzione su true disabiliterà completamente sia l'individuazione dell'istanza che la convalida dell'autorità. Di conseguenza, è fondamentale assicurarsi che l'host dell'autorità configurata sia valido e affidabile. Questa funzionalità è destinata all'uso in scenari in cui non è possibile raggiungere l'endpoint dei metadati, ad esempio nei cloud privati o in Azure Stack. Il processo di individuazione dell'istanza comporta il recupero dei metadati dell'autorità da https://login.microsoft.com/ per convalidare l'autorità.
httpClient

HttpClient che verrà usato per inviare richieste HTTP.
loggingOptions

Consente agli utenti di configurare le impostazioni per le opzioni dei criteri di registrazione, consentire la registrazione delle informazioni sull'account e le informazioni personali per il supporto tecnico.
proxyOptions

Opzioni per configurare un proxy per le richieste in uscita.
redirectOptions

Opzioni per la gestione delle risposte di reindirizzamento.
retryOptions

Opzioni che controllano come ripetere le richieste non riuscite.
telemetryOptions

Opzioni per impostare dati di telemetria comuni e informazioni di traccia alle richieste in uscita.
tlsOptions

Opzioni per la configurazione dell'autenticazione TLS
tokenCachePersistenceOptions

Opzioni per fornire al livello di persistenza (se disponibile) durante l'archiviazione delle credenziali.

È prima necessario registrare un plug-in del provider di persistenza. Vedere il @azure/identity-cache-persistence pacchetto in Monitoraggio prestazioni rete.

Esempio:

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);
});
userAgentOptions

Opzioni per aggiungere i dettagli dell'agente utente alle richieste in uscita.

Dettagli proprietà ereditate

additionallyAllowedTenants

Per le applicazioni multi-tenant, specifica tenant aggiuntivi per i quali le credenziali possono acquisire i token. Aggiungere il valore jolly "*" per consentire alle credenziali di acquisire i token per qualsiasi tenant in cui è installata l'applicazione.

additionallyAllowedTenants?: string[]

Valore della proprietà

string[]

Ereditato daMultiTenantTokenCredentialOptions.additionalAllowedTenants

additionalPolicies

Criteri aggiuntivi da includere nella pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valore della proprietà

AdditionalPolicyConfig[]

Ereditato daMultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

Impostare su true se la richiesta viene inviata tramite HTTP anziché HTTPS

allowInsecureConnection?: boolean

Valore della proprietà

boolean

Ereditato daMultiTenantTokenCredentialOptions.allowInsecureConnection

authorityHost

Host dell'autorità da usare per le richieste di autenticazione. I valori possibili sono disponibili tramite AzureAuthorityHosts. Il valore predefinito è "https://login.microsoftonline.com".

authorityHost?: string

Valore della proprietà

string

Ereditato daMultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

Il campo determina se l'individuazione dell'istanza viene eseguita quando si tenta di eseguire l'autenticazione. L'impostazione di questa opzione su true disabiliterà completamente sia l'individuazione dell'istanza che la convalida dell'autorità. Di conseguenza, è fondamentale assicurarsi che l'host dell'autorità configurata sia valido e affidabile. Questa funzionalità è destinata all'uso in scenari in cui non è possibile raggiungere l'endpoint dei metadati, ad esempio nei cloud privati o in Azure Stack. Il processo di individuazione dell'istanza comporta il recupero dei metadati dell'autorità da https://login.microsoft.com/ per convalidare l'autorità.

disableInstanceDiscovery?: boolean

Valore della proprietà

boolean

Ereditato daAuthorityValidationOptions.disableInstanceDiscovery

httpClient

HttpClient che verrà usato per inviare richieste HTTP.

httpClient?: HttpClient

Valore della proprietà

HttpClient

Ereditato daMultiTenantTokenCredentialOptions.httpClient

loggingOptions

Consente agli utenti di configurare le impostazioni per le opzioni dei criteri di registrazione, consentire la registrazione delle informazioni sull'account e le informazioni personali per il supporto tecnico.

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

Valore della proprietà

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

Ereditato daMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

Opzioni per configurare un proxy per le richieste in uscita.

proxyOptions?: ProxySettings

Valore della proprietà

ProxySettings

Ereditato daMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Opzioni per la gestione delle risposte di reindirizzamento.

redirectOptions?: RedirectPolicyOptions

Valore della proprietà

RedirectPolicyOptions

Ereditato daMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

Opzioni che controllano come ripetere le richieste non riuscite.

retryOptions?: PipelineRetryOptions

Valore della proprietà

PipelineRetryOptions

Ereditato daMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

Opzioni per impostare dati di telemetria comuni e informazioni di traccia alle richieste in uscita.

telemetryOptions?: TelemetryOptions

Valore della proprietà

TelemetryOptions

Ereditato daMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

Opzioni per la configurazione dell'autenticazione TLS

tlsOptions?: TlsSettings

Valore della proprietà

TlsSettings

Ereditato daMultiTenantTokenCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Opzioni per fornire al livello di persistenza (se disponibile) durante l'archiviazione delle credenziali.

È prima necessario registrare un plug-in del provider di persistenza. Vedere il @azure/identity-cache-persistence pacchetto in Monitoraggio prestazioni rete.

Esempio:

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

Valore della proprietà

TokenCachePersistenceOptions

Ereditato daCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Opzioni per aggiungere i dettagli dell'agente utente alle richieste in uscita.

userAgentOptions?: UserAgentPolicyOptions

Valore della proprietà

UserAgentPolicyOptions

Ereditato daMultiTenantTokenCredentialOptions.userAgentOptions