DefaultAzureCredentialClientIdOptions interface
Udostępnia opcje konfigurowania klasy DefaultAzureCredential .
Ta odmiana jest obsługiwana managedIdentityClientId
, a nie managedIdentityResourceId
, ponieważ obsługiwana jest tylko jedna z obu opcji.
- Extends
Właściwości
managed |
Opcjonalnie przekaż identyfikator klienta przypisanego przez użytkownika, aby był używany przez właściwość ManagedIdentityCredential. Ten identyfikator klienta można również przekazać do zmiennej środowiskowej ManagedIdentityCredential : AZURE_CLIENT_ID. |
workload |
Opcjonalnie przekaż identyfikator klienta przypisanego przez użytkownika, który ma być używany przez element WorkloadIdentityCredential. Ten identyfikator klienta można również przekazać do zmiennej środowiskowej WorkloadIdentityCredential : AZURE_CLIENT_ID. |
Właściwości dziedziczone
additionally |
W przypadku aplikacji z wieloma dzierżawami określa dodatkowe dzierżawy, dla których poświadczenia mogą uzyskiwać tokeny. Dodaj wartość symbolu wieloznakowego "*", aby umożliwić poświadczeniu uzyskiwanie tokenów dla dowolnej dzierżawy zainstalowanej aplikacji. |
additional |
Dodatkowe zasady do uwzględnienia w potoku HTTP. |
allow |
Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS |
authority |
Host urzędu do użycia na potrzeby żądań uwierzytelniania. Możliwe wartości są dostępne za pośrednictwem elementu AzureAuthorityHosts. Wartość domyślna to "https://login.microsoftonline.com". |
disable |
Pole określa, czy odnajdywanie wystąpień jest wykonywane podczas próby uwierzytelnienia.
Ustawienie tego ustawienia |
http |
Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP. |
logging |
Umożliwia użytkownikom konfigurowanie ustawień opcji zasad rejestrowania, zezwalanie na rejestrowanie informacji o koncie i danych osobowych na potrzeby obsługi klienta. |
process |
Limit czasu można skonfigurować do tworzenia żądań tokenu dla poświadczeń dewelopera, a mianowicie , <xref:AzurePowershellCredential>AzureDeveloperCliCredential i AzureCliCredential. Limit czasu procesu dla poświadczeń należy podać w milisekundach. |
proxy |
Opcje konfigurowania serwera proxy dla żądań wychodzących. |
redirect |
Opcje obsługi odpowiedzi przekierowania. |
retry |
Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem. |
telemetry |
Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące. |
tenant |
Opcjonalnie przekaż identyfikator dzierżawy, który ma być używany jako część poświadczeń. Domyślnie może używać ogólnego identyfikatora dzierżawy w zależności od poświadczeń bazowych. |
tls |
Opcje konfigurowania uwierzytelniania TLS |
user |
Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących. |
Szczegóły właściwości
managedIdentityClientId
Opcjonalnie przekaż identyfikator klienta przypisanego przez użytkownika, aby był używany przez właściwość ManagedIdentityCredential. Ten identyfikator klienta można również przekazać do zmiennej środowiskowej ManagedIdentityCredential : AZURE_CLIENT_ID.
managedIdentityClientId?: string
Wartość właściwości
string
workloadIdentityClientId
Opcjonalnie przekaż identyfikator klienta przypisanego przez użytkownika, który ma być używany przez element WorkloadIdentityCredential. Ten identyfikator klienta można również przekazać do zmiennej środowiskowej WorkloadIdentityCredential : AZURE_CLIENT_ID.
workloadIdentityClientId?: string
Wartość właściwości
string
Szczegóły właściwości dziedziczonej
additionallyAllowedTenants
W przypadku aplikacji z wieloma dzierżawami określa dodatkowe dzierżawy, dla których poświadczenia mogą uzyskiwać tokeny. Dodaj wartość symbolu wieloznakowego "*", aby umożliwić poświadczeniu uzyskiwanie tokenów dla dowolnej dzierżawy zainstalowanej aplikacji.
additionallyAllowedTenants?: string[]
Wartość właściwości
string[]
Dziedziczone zelementu DefaultAzureCredentialOptions.additionallyAllowedTenants
additionalPolicies
Dodatkowe zasady do uwzględnienia w potoku HTTP.
additionalPolicies?: AdditionalPolicyConfig[]
Wartość właściwości
Dziedziczone zdefaultAzureCredentialOptions.additionalPolicies
allowInsecureConnection
Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS
allowInsecureConnection?: boolean
Wartość właściwości
boolean
Dziedziczone zdefaultAzureCredentialOptions.allowInsecureConnection
authorityHost
Host urzędu do użycia na potrzeby żądań uwierzytelniania. Możliwe wartości są dostępne za pośrednictwem elementu AzureAuthorityHosts. Wartość domyślna to "https://login.microsoftonline.com".
authorityHost?: string
Wartość właściwości
string
Dziedziczone zdefaultAzureCredentialOptions.authorityHost
disableInstanceDiscovery
Pole określa, czy odnajdywanie wystąpień jest wykonywane podczas próby uwierzytelnienia.
Ustawienie tego ustawienia true
spowoduje całkowite wyłączenie zarówno odnajdywania wystąpień, jak i weryfikacji urzędu.
W związku z tym niezwykle ważne jest upewnienie się, że skonfigurowany host urzędu jest prawidłowy i godny zaufania.
Ta funkcja jest przeznaczona do użycia w scenariuszach, w których nie można uzyskać dostępu do punktu końcowego metadanych, na przykład w chmurach prywatnych lub usłudze Azure Stack.
Proces odnajdywania wystąpień wiąże się z pobieraniem metadanych urzędu z https://login.microsoft.com/ programu w celu zweryfikowania urzędu.
disableInstanceDiscovery?: boolean
Wartość właściwości
boolean
Dziedziczone zelementu DefaultAzureCredentialOptions.disableInstanceDiscovery
httpClient
Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.
httpClient?: HttpClient
Wartość właściwości
Dziedziczone zelementu DefaultAzureCredentialOptions.httpClient
loggingOptions
Umożliwia użytkownikom konfigurowanie ustawień opcji zasad rejestrowania, zezwalanie na rejestrowanie informacji o koncie i danych osobowych na potrzeby obsługi klienta.
loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
Wartość właściwości
LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
Dziedziczone zdefaultAzureCredentialOptions.loggingOptions
processTimeoutInMs
Limit czasu można skonfigurować do tworzenia żądań tokenu dla poświadczeń dewelopera, a mianowicie , <xref:AzurePowershellCredential>AzureDeveloperCliCredential i AzureCliCredential. Limit czasu procesu dla poświadczeń należy podać w milisekundach.
processTimeoutInMs?: number
Wartość właściwości
number
Dziedziczone zdefaultAzureCredentialOptions.processTimeoutInMs
proxyOptions
Opcje konfigurowania serwera proxy dla żądań wychodzących.
proxyOptions?: ProxySettings
Wartość właściwości
Dziedziczone zdefaultAzureCredentialOptions.proxyOptions
redirectOptions
Opcje obsługi odpowiedzi przekierowania.
redirectOptions?: RedirectPolicyOptions
Wartość właściwości
Dziedziczone zdefaultAzureCredentialOptions.redirectOptions
retryOptions
Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
retryOptions?: PipelineRetryOptions
Wartość właściwości
Dziedziczone zdefaultAzureCredentialOptions.retryOptions
telemetryOptions
Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.
telemetryOptions?: TelemetryOptions
Wartość właściwości
Dziedziczone zdefaultAzureCredentialOptions.telemetryOptions
tenantId
Opcjonalnie przekaż identyfikator dzierżawy, który ma być używany jako część poświadczeń. Domyślnie może używać ogólnego identyfikatora dzierżawy w zależności od poświadczeń bazowych.
tenantId?: string
Wartość właściwości
string
Dziedziczone zdefaultAzureCredentialOptions.tenantId
tlsOptions
Opcje konfigurowania uwierzytelniania TLS
tlsOptions?: TlsSettings
Wartość właściwości
Dziedziczone zdefaultAzureCredentialOptions.tlsOptions
userAgentOptions
Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.
userAgentOptions?: UserAgentPolicyOptions
Wartość właściwości
Dziedziczone zdefaultAzureCredentialOptions.userAgentOptions