WorkloadIdentityCredentialOptions interface

Paket:

@azure/identity

Alternativ för WorkloadIdentityCredential

Extends

MultiTenantTokenCredentialOptions,AuthorityValidationOptions

Egenskaper

clientId	Klient-ID för en Microsoft Entra appregistrering.
tenantId	ID för programmets Microsoft Entra klientorganisation. Kallas även dess katalog-ID.
tokenFilePath	Sökvägen till en fil som innehåller en Kubernetes-tjänstkontotoken som autentiserar identiteten.

Ärvda egenskaper

additionallyAllowedTenants	För program med flera klientorganisationer anger ytterligare klientorganisationer för vilka autentiseringsuppgifterna kan hämta token. Lägg till jokertecknet "*" så att autentiseringsuppgifterna kan hämta token för alla klientorganisationer som programmet är installerat på.
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 detta anges till true inaktiveras både instansidentifiering och utfärdarvalidering helt. Därför är det viktigt att se till att den konfigurerade utfärdarvärden ä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 utfärdarmetadata 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	Gör att användare kan konfigurera inställningar för alternativ för loggningsprinciper, 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 ställa in vanlig telemetri och spårningsinformation för utgående begäranden.
tlsOptions	Alternativ för att konfigurera TLS-autentisering
userAgentOptions	Alternativ för att lägga till användaragentinformation i utgående begäranden.

Egenskapsinformation

clientId

Klient-ID för en Microsoft Entra appregistrering.

clientId?: string

Egenskapsvärde

string

tenantId

ID för programmets Microsoft Entra klientorganisation. Kallas även dess katalog-ID.

tenantId?: string

Egenskapsvärde

string

tokenFilePath

Sökvägen till en fil som innehåller en Kubernetes-tjänstkontotoken som autentiserar identiteten.

tokenFilePath?: string

Egenskapsvärde

string

Information om ärvda egenskaper

additionallyAllowedTenants

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

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 detta anges till true inaktiveras både instansidentifiering och utfärdarvalidering helt. Därför är det viktigt att se till att den konfigurerade utfärdarvärden ä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 utfärdarmetadata 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

Gör att användare kan konfigurera inställningar för alternativ för loggningsprinciper, 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 ställa in 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

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Egenskapsvärde

UserAgentPolicyOptions

Ärvd frånMultiTenantTokenCredentialOptions.userAgentOptions