DefaultAzureCredentialOptions interface

Pacote:

@azure/identity

Fornece opções para configurar a classe DefaultAzureCredential.

Extends

MultiTenantTokenCredentialOptions,AuthorityValidationOptions

Propriedades

processTimeoutInMs	Tempo limite configurável para fazer solicitações de token para credenciais de desenvolvedor, ou seja, <xref:AzurePowershellCredential>, AzureDeveloperCliCredential e AzureCliCredential. O tempo limite do processo para credenciais deve ser fornecido em milissegundos.
requiredEnvVars	Lista de variáveis de ambiente que devem ser definidas no tempo de execução. Se alguma variável nesta lista estiver ausente ou definida como um valor vazio, o construtor DefaultAzureCredential gerará um erro. Use isso para impor que seu aplicativo tenha a configuração de ambiente necessária antes de continuar a execução.
tenantId	Opcionalmente, passe uma ID de Locatário a ser usada como parte da credencial. Por padrão, ele pode usar uma ID de locatário genérica, dependendo da credencial subjacente.

Propriedades herdadas

additionallyAllowedTenants	Para aplicativos multilocatários, especifica locatários adicionais para os quais a credencial pode adquirir tokens. Adicione o valor curinga "*" para permitir que a credencial adquira tokens para qualquer locatário que o aplicativo esteja instalado.
additionalPolicies	Políticas adicionais a serem incluídas no pipeline HTTP.
agent	Opções para configurar a instância do Agente para solicitações de saída
allowInsecureConnection	Definir como true se a solicitação for enviada por HTTP em vez de HTTPS
authorityHost	O host de autoridade a ser usado para solicitações de autenticação. Os valores possíveis estão disponíveis por meio de AzureAuthorityHosts . O padrão é "https://login.microsoftonline.com".
disableInstanceDiscovery	O campo determina se a descoberta de instância é executada ao tentar se autenticar. Definir isso como true desabilitará completamente a descoberta de instância e a validação de autoridade. Como resultado, é crucial garantir que o host de autoridade configurado seja válido e confiável. Essa funcionalidade destina-se ao uso em cenários em que o ponto de extremidade de metadados não pode ser alcançado, como em nuvens privadas ou no Azure Stack. O processo de descoberta de instância envolve a recuperação de metadados de https://login.microsoft.com/ autoridade para validar a autoridade.
httpClient	O HttpClient que será usado para enviar solicitações HTTP.
loggingOptions	Permite que os usuários definam configurações para opções de política de registro em log, permitir informações de conta de log e informações de identificação pessoal para o suporte ao cliente.
proxyOptions	Opções para configurar um proxy para solicitações de saída.
redirectOptions	Opções de como as respostas de redirecionamento são tratadas.
retryOptions	Opções que controlam como repetir solicitações com falha.
telemetryOptions	Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.
tlsOptions	Opções para configurar a autenticação do TLS
userAgentOptions	Opções para adicionar detalhes do agente de usuário a solicitações de saída.

Detalhes da propriedade

processTimeoutInMs

Tempo limite configurável para fazer solicitações de token para credenciais de desenvolvedor, ou seja, <xref:AzurePowershellCredential>, AzureDeveloperCliCredential e AzureCliCredential. O tempo limite do processo para credenciais deve ser fornecido em milissegundos.

processTimeoutInMs?: number

Valor da propriedade

number

requiredEnvVars

Lista de variáveis de ambiente que devem ser definidas no tempo de execução. Se alguma variável nesta lista estiver ausente ou definida como um valor vazio, o construtor DefaultAzureCredential gerará um erro. Use isso para impor que seu aplicativo tenha a configuração de ambiente necessária antes de continuar a execução.

requiredEnvVars?: DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

Valor da propriedade

DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

tenantId

Opcionalmente, passe uma ID de Locatário a ser usada como parte da credencial. Por padrão, ele pode usar uma ID de locatário genérica, dependendo da credencial subjacente.

tenantId?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

additionallyAllowedTenants

Para aplicativos multilocatários, especifica locatários adicionais para os quais a credencial pode adquirir tokens. Adicione o valor curinga "*" para permitir que a credencial adquira tokens para qualquer locatário que o aplicativo esteja instalado.

additionallyAllowedTenants?: string[]

Valor da propriedade

string[]

Herdado deMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

Políticas adicionais a serem incluídas no pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor da propriedade

AdditionalPolicyConfig[]

Herdado deMultiTenantTokenCredentialOptions.additionalPolicies

agent

Opções para configurar a instância do Agente para solicitações de saída

agent?: Agent

Valor da propriedade

Agent

herdado demultiTenantTokenCredentialOptions.agent

allowInsecureConnection

Definir como true se a solicitação for enviada por HTTP em vez de HTTPS

allowInsecureConnection?: boolean

Valor da propriedade

boolean

Herdado deMultiTenantTokenCredentialOptions.allowInsecureConnection

authorityHost

O host de autoridade a ser usado para solicitações de autenticação. Os valores possíveis estão disponíveis por meio de AzureAuthorityHosts . O padrão é "https://login.microsoftonline.com".

authorityHost?: string

Valor da propriedade

string

Herdado de MultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

O campo determina se a descoberta de instância é executada ao tentar se autenticar. Definir isso como true desabilitará completamente a descoberta de instância e a validação de autoridade. Como resultado, é crucial garantir que o host de autoridade configurado seja válido e confiável. Essa funcionalidade destina-se ao uso em cenários em que o ponto de extremidade de metadados não pode ser alcançado, como em nuvens privadas ou no Azure Stack. O processo de descoberta de instância envolve a recuperação de metadados de https://login.microsoft.com/ autoridade para validar a autoridade.

disableInstanceDiscovery?: boolean

Valor da propriedade

boolean

Herdado deAuthorityValidationOptions.disableInstanceDiscovery

httpClient

O HttpClient que será usado para enviar solicitações HTTP.

httpClient?: HttpClient

Valor da propriedade

HttpClient

Herdado deMultiTenantTokenCredentialOptions.httpClient

loggingOptions

Permite que os usuários definam configurações para opções de política de registro em log, permitir informações de conta de log e informações de identificação pessoal para o suporte ao cliente.

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

Valor da propriedade

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

Herdado deMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

Opções para configurar um proxy para solicitações de saída.

proxyOptions?: ProxySettings

Valor da propriedade

ProxySettings

Herdado deMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Opções de como as respostas de redirecionamento são tratadas.

redirectOptions?: RedirectPolicyOptions

Valor da propriedade

RedirectPolicyOptions

Herdado deMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

Opções que controlam como repetir solicitações com falha.

retryOptions?: PipelineRetryOptions

Valor da propriedade

PipelineRetryOptions

Herdado deMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.

telemetryOptions?: TelemetryOptions

Valor da propriedade

TelemetryOptions

Herdado deMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

Opções para configurar a autenticação do TLS

tlsOptions?: TlsSettings

Valor da propriedade

TlsSettings

Herdado deMultiTenantTokenCredentialOptions.tlsOptions

userAgentOptions

Opções para adicionar detalhes do agente de usuário a solicitações de saída.

userAgentOptions?: UserAgentPolicyOptions

Valor da propriedade

UserAgentPolicyOptions

Herdado deMultiTenantTokenCredentialOptions.userAgentOptions