Delen via

ClientCertificateCredentialOptions interface

  • Referentie
Pakket:
@azure/identity

Optionele parameters voor de klasse ClientCertificateCredential .

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

Eigenschappen

sendCertificateChain

Optie voor het opnemen van x5c-headers voor autorisatie van onderwerpnaam en naam van verlener. Stel deze optie in om base64 gecodeerd openbaar certificaat in de clientassertieheader te verzenden als een x5c-claim

Overgenomen eigenschappen

additionallyAllowedTenants

Voor toepassingen met meerdere tenants geeft u extra tenants op waarvoor de referentie tokens kan verkrijgen. Voeg de jokertekenwaarde *toe om de referentie toe te staan tokens te verkrijgen voor elke tenant die de toepassing is geïnstalleerd.
additionalPolicies

Aanvullende beleidsregels die moeten worden opgenomen in de HTTP-pijplijn.
allowInsecureConnection

Ingesteld op waar als de aanvraag wordt verzonden via HTTP in plaats van HTTPS
authorityHost

De instantiehost die moet worden gebruikt voor verificatieaanvragen. Mogelijke waarden zijn beschikbaar via AzureAuthorityHosts. De standaardwaarde is "https://login.microsoftonline.com".
disableInstanceDiscovery

Het veld bepaalt of exemplaardetectie wordt uitgevoerd bij een verificatiepoging. Als u dit instelt op true , wordt zowel exemplaardetectie als instantievalidatie volledig uitgeschakeld. Daarom is het essentieel om ervoor te zorgen dat de geconfigureerde instantiehost geldig en betrouwbaar is. Deze functionaliteit is bedoeld voor gebruik in scenario's waarin het eindpunt voor metagegevens niet kan worden bereikt, zoals in privéclouds of Azure Stack. Het proces van exemplaardetectie omvat het ophalen van instantiemetagegevens van https://login.microsoft.com/ om de instantie te valideren.
httpClient

De HttpClient die wordt gebruikt voor het verzenden van HTTP-aanvragen.
loggingOptions

Hiermee kunnen gebruikers instellingen configureren voor beleidsopties voor logboekregistratie, accountgegevens voor logboekregistratie en persoonsgegevens voor klantondersteuning toestaan.
proxyOptions

Opties voor het configureren van een proxy voor uitgaande aanvragen.
redirectOptions

Opties voor hoe omleidingsreacties worden verwerkt.
retryOptions

Opties die bepalen hoe mislukte aanvragen opnieuw moeten worden geprobeerd.
telemetryOptions

Opties voor het instellen van algemene telemetrie en het traceren van gegevens voor uitgaande aanvragen.
tlsOptions

Opties voor het configureren van TLS-verificatie
tokenCachePersistenceOptions

Opties voor de persistentielaag (indien beschikbaar) bij het opslaan van referenties.

U moet eerst een invoegtoepassing voor een persistentieprovider registreren. Bekijk het @azure/identity-cache-persistence pakket op NPM.

Voorbeeld:

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

Opties voor het toevoegen van gebruikersagentgegevens aan uitgaande aanvragen.

Eigenschapdetails

sendCertificateChain

Optie voor het opnemen van x5c-headers voor autorisatie van onderwerpnaam en naam van verlener. Stel deze optie in om base64 gecodeerd openbaar certificaat in de clientassertieheader te verzenden als een x5c-claim

sendCertificateChain?: boolean

Waarde van eigenschap

boolean

Details van overgenomen eigenschap

additionallyAllowedTenants

Voor toepassingen met meerdere tenants geeft u extra tenants op waarvoor de referentie tokens kan verkrijgen. Voeg de jokertekenwaarde *toe om de referentie toe te staan tokens te verkrijgen voor elke tenant die de toepassing is geïnstalleerd.

additionallyAllowedTenants?: string[]

Waarde van eigenschap

string[]

Overgenomen vanMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

Aanvullende beleidsregels die moeten worden opgenomen in de HTTP-pijplijn.

additionalPolicies?: AdditionalPolicyConfig[]

Waarde van eigenschap

AdditionalPolicyConfig[]

Overgenomen vanMultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

Ingesteld op waar als de aanvraag wordt verzonden via HTTP in plaats van HTTPS

allowInsecureConnection?: boolean

Waarde van eigenschap

boolean

Overgenomen vanMultiTenantTokenCredentialOptions.allowInsecureConnection

authorityHost

De instantiehost die moet worden gebruikt voor verificatieaanvragen. Mogelijke waarden zijn beschikbaar via AzureAuthorityHosts. De standaardwaarde is "https://login.microsoftonline.com".

authorityHost?: string

Waarde van eigenschap

string

Overgenomen vanMultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

Het veld bepaalt of exemplaardetectie wordt uitgevoerd bij een verificatiepoging. Als u dit instelt op true , wordt zowel exemplaardetectie als instantievalidatie volledig uitgeschakeld. Daarom is het essentieel om ervoor te zorgen dat de geconfigureerde instantiehost geldig en betrouwbaar is. Deze functionaliteit is bedoeld voor gebruik in scenario's waarin het eindpunt voor metagegevens niet kan worden bereikt, zoals in privéclouds of Azure Stack. Het proces van exemplaardetectie omvat het ophalen van instantiemetagegevens van https://login.microsoft.com/ om de instantie te valideren.

disableInstanceDiscovery?: boolean

Waarde van eigenschap

boolean

Overgenomen vanAuthorityValidationOptions.disableInstanceDiscovery

httpClient

De HttpClient die wordt gebruikt voor het verzenden van HTTP-aanvragen.

httpClient?: HttpClient

Waarde van eigenschap

HttpClient

Overgenomen vanMultiTenantTokenCredentialOptions.httpClient

loggingOptions

Hiermee kunnen gebruikers instellingen configureren voor beleidsopties voor logboekregistratie, accountgegevens voor logboekregistratie en persoonsgegevens voor klantondersteuning toestaan.

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

Waarde van eigenschap

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

Overgenomen vanMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

Opties voor het configureren van een proxy voor uitgaande aanvragen.

proxyOptions?: ProxySettings

Waarde van eigenschap

ProxySettings

Overgenomen vanMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Opties voor hoe omleidingsreacties worden verwerkt.

redirectOptions?: RedirectPolicyOptions

Waarde van eigenschap

RedirectPolicyOptions

Overgenomen vanMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

Opties die bepalen hoe mislukte aanvragen opnieuw moeten worden geprobeerd.

retryOptions?: PipelineRetryOptions

Waarde van eigenschap

PipelineRetryOptions

Overgenomen vanMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

Opties voor het instellen van algemene telemetrie en het traceren van gegevens voor uitgaande aanvragen.

telemetryOptions?: TelemetryOptions

Waarde van eigenschap

TelemetryOptions

Overgenomen vanMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

Opties voor het configureren van TLS-verificatie

tlsOptions?: TlsSettings

Waarde van eigenschap

TlsSettings

Overgenomen vanMultiTenantTokenCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Opties voor de persistentielaag (indien beschikbaar) bij het opslaan van referenties.

U moet eerst een invoegtoepassing voor een persistentieprovider registreren. Bekijk het @azure/identity-cache-persistence pakket op NPM.

Voorbeeld:

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

Waarde van eigenschap

TokenCachePersistenceOptions

Overgenomen vanCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Opties voor het toevoegen van gebruikersagentgegevens aan uitgaande aanvragen.

userAgentOptions?: UserAgentPolicyOptions

Waarde van eigenschap

UserAgentPolicyOptions

Overgenomen vanMultiTenantTokenCredentialOptions.userAgentOptions