Dela via

ClientSecretCredentialOptions interface

  • Referens
Paket:
@azure/identity

Valfria parametrar för klassen ClientSecretCredential .

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

Ärvda egenskaper

additionallyAllowedTenants

För program med flera klientorganisationer anger ytterligare klienter för vilka autentiseringsuppgifterna kan hämta token. Lägg till jokertecknets värde "*" så att autentiseringsuppgifterna kan hämta token för alla klientorganisationer som programmet är installerat.
additionalPolicies

Ytterligare principer som ska ingå i HTTP-pipelinen.
allowInsecureConnection

Ange till true om begäran skickas via HTTP i stället för HTTPS
authorityHost

Den utfärdarvärd som ska användas för autentiseringsbegäranden. Möjliga värden är tillgängliga via AzureAuthorityHosts. Standardvärdet är "https://login.microsoftonline.com".
disableInstanceDiscovery

Fältet avgör om instansidentifiering utförs vid försök att autentisera. Om du anger detta inaktiveras true både instansidentifiering och verifiering av utfärdare helt. Därför är det viktigt att se till att den konfigurerade utfärdarens värd är giltig och tillförlitlig. Den här funktionen är avsedd att användas i scenarier där metadataslutpunkten inte kan nås, till exempel i privata moln eller Azure Stack. Processen för instansidentifiering innebär att auktoritetsmetadata hämtas från https://login.microsoft.com/ för att verifiera utfärdaren.
httpClient

Den HttpClient som ska användas för att skicka HTTP-begäranden.
loggingOptions

Tillåter användare att konfigurera inställningar för loggningsprincipalternativ, tillåta loggning av kontoinformation och personligt identifierbar information för kundsupport.
proxyOptions

Alternativ för att konfigurera en proxy för utgående begäranden.
redirectOptions

Alternativ för hur omdirigeringssvar hanteras.
retryOptions

Alternativ som styr hur du försöker utföra misslyckade begäranden igen.
telemetryOptions

Alternativ för att ange vanlig telemetri och spårningsinformation för utgående begäranden.
tlsOptions

Alternativ för att konfigurera TLS-autentisering
tokenCachePersistenceOptions

Alternativ för att tillhandahålla beständighetsskiktet (om en är tillgänglig) vid lagring av autentiseringsuppgifter.

Du måste först registrera ett plugin-program för beständighetsprovider. Se paketet på @azure/identity-cache-persistence NPM.

Exempel:

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

Alternativ för att lägga till användaragentinformation i utgående begäranden.

Information om ärvda egenskaper

additionallyAllowedTenants

För program med flera klientorganisationer anger ytterligare klienter för vilka autentiseringsuppgifterna kan hämta token. Lägg till jokertecknets värde "*" så att autentiseringsuppgifterna kan hämta token för alla klientorganisationer som programmet är installerat.

additionallyAllowedTenants?: string[]

Egenskapsvärde

string[]

Ärvd frånMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

Ytterligare principer som ska ingå i HTTP-pipelinen.

additionalPolicies?: AdditionalPolicyConfig[]

Egenskapsvärde

AdditionalPolicyConfig[]

Ärvd frånMultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

Ange till true om begäran skickas via HTTP i stället för HTTPS

allowInsecureConnection?: boolean

Egenskapsvärde

boolean

Ärvd frånMultiTenantTokenCredentialOptions.allowInsecureConnection

authorityHost

Den utfärdarvärd som ska användas för autentiseringsbegäranden. Möjliga värden är tillgängliga via AzureAuthorityHosts. Standardvärdet är "https://login.microsoftonline.com".

authorityHost?: string

Egenskapsvärde

string

Ärvd frånMultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

Fältet avgör om instansidentifiering utförs vid försök att autentisera. Om du anger detta inaktiveras true både instansidentifiering och verifiering av utfärdare helt. Därför är det viktigt att se till att den konfigurerade utfärdarens värd är giltig och tillförlitlig. Den här funktionen är avsedd att användas i scenarier där metadataslutpunkten inte kan nås, till exempel i privata moln eller Azure Stack. Processen för instansidentifiering innebär att auktoritetsmetadata hämtas från https://login.microsoft.com/ för att verifiera utfärdaren.

disableInstanceDiscovery?: boolean

Egenskapsvärde

boolean

Ärvd frånAuthorityValidationOptions.disableInstanceDiscovery

httpClient

Den HttpClient som ska användas för att skicka HTTP-begäranden.

httpClient?: HttpClient

Egenskapsvärde

HttpClient

Ärvd frånMultiTenantTokenCredentialOptions.httpClient

loggingOptions

Tillåter användare att konfigurera inställningar för loggningsprincipalternativ, tillåta loggning av kontoinformation och personligt identifierbar information för kundsupport.

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

Egenskapsvärde

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

Ärvd frånMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

Alternativ för att konfigurera en proxy för utgående begäranden.

proxyOptions?: ProxySettings

Egenskapsvärde

ProxySettings

Ärvd frånMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Alternativ för hur omdirigeringssvar hanteras.

redirectOptions?: RedirectPolicyOptions

Egenskapsvärde

RedirectPolicyOptions

Ärvd frånMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

Alternativ som styr hur du försöker utföra misslyckade begäranden igen.

retryOptions?: PipelineRetryOptions

Egenskapsvärde

PipelineRetryOptions

Ärvd frånMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

Alternativ för att ange vanlig telemetri och spårningsinformation för utgående begäranden.

telemetryOptions?: TelemetryOptions

Egenskapsvärde

TelemetryOptions

Ärvd frånMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

Alternativ för att konfigurera TLS-autentisering

tlsOptions?: TlsSettings

Egenskapsvärde

TlsSettings

Ärvd frånMultiTenantTokenCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Alternativ för att tillhandahålla beständighetsskiktet (om en är tillgänglig) vid lagring av autentiseringsuppgifter.

Du måste först registrera ett plugin-program för beständighetsprovider. Se paketet på @azure/identity-cache-persistence NPM.

Exempel:

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

Egenskapsvärde

TokenCachePersistenceOptions

Ärvd frånCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Alternativ för att lägga till användaragentinformation i utgående begäranden.

userAgentOptions?: UserAgentPolicyOptions

Egenskapsvärde

UserAgentPolicyOptions

Ärvd frånMultiTenantTokenCredentialOptions.userAgentOptions