DefaultAzureCredentialClientIdOptions interface

Pacote:

@azure/identity

Fornece opções para configurar o classe de DefaultAzureCredential. Esta variação suporta managedIdentityClientId e não managedIdentityResourceId, uma vez que apenas um dos dois é suportado.

Extends

DefaultAzureCredentialOptions

Propriedades

managedIdentityClientId	Opcionalmente, passe um ID de cliente atribuído ao usuário para ser usado pelo ManagedIdentityCredential. Esse ID de cliente também pode ser passado para o ManagedIdentityCredential do através da variável de ambiente: AZURE_CLIENT_ID.
workloadIdentityClientId	Opcionalmente, passe um ID de cliente atribuído ao usuário para ser usado pelo WorkloadIdentityCredential. Esse ID de cliente também pode ser passado para o WorkloadIdentityCredential através da variável de ambiente: AZURE_CLIENT_ID.

Propriedades Herdadas

additionallyAllowedTenants	Para aplicativos multilocatário, 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	Defina 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 AzureAuthorityHosts. O padrão é "https://login.microsoftonline.com".
disableInstanceDiscovery	O campo determina se a descoberta de instância é executada ao tentar autenticar. Definir isso como true desativará 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 configurem configurações para registrar opções de política, permitir o registro de informações de conta e informações de identificação pessoal para suporte ao cliente.
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.
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.
tenantId	Opcionalmente, passe uma ID de locatário para ser usada como parte da credencial. Por padrão, ele pode usar um ID de locatário genérico, dependendo da credencial subjacente.
tlsOptions	Opções para configurar a autenticação TLS
userAgentOptions	Opções para adicionar detalhes do agente do usuário às solicitações de saída.

Detalhes de Propriedade

managedIdentityClientId

Opcionalmente, passe um ID de cliente atribuído ao usuário para ser usado pelo ManagedIdentityCredential. Esse ID de cliente também pode ser passado para o ManagedIdentityCredential do através da variável de ambiente: AZURE_CLIENT_ID.

managedIdentityClientId?: string

Valor de Propriedade

string

workloadIdentityClientId

Opcionalmente, passe um ID de cliente atribuído ao usuário para ser usado pelo WorkloadIdentityCredential. Esse ID de cliente também pode ser passado para o WorkloadIdentityCredential através da variável de ambiente: AZURE_CLIENT_ID.

workloadIdentityClientId?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

additionallyAllowedTenants

Para aplicativos multilocatário, 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 de Propriedade

string[]

herdado deDefaultAzureCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Valor de Propriedade

AdditionalPolicyConfig[]

herdado de DefaultAzureCredentialOptions.additionalPolicies

agent

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

agent?: Agent

Valor de Propriedade

Agent

herdado de DefaultAzureCredentialOptions.agent

allowInsecureConnection

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

allowInsecureConnection?: boolean

Valor de Propriedade

boolean

herdado de DefaultAzureCredentialOptions.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 AzureAuthorityHosts. O padrão é "https://login.microsoftonline.com".

authorityHost?: string

Valor de Propriedade

string

herdado de DefaultAzureCredentialOptions.authorityHost

disableInstanceDiscovery

O campo determina se a descoberta de instância é executada ao tentar autenticar. Definir isso como true desativará 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 de Propriedade

boolean

herdado de DefaultAzureCredentialOptions.disableInstanceDiscovery

httpClient

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

httpClient?: HttpClient

Valor de Propriedade

HttpClient

herdado de DefaultAzureCredentialOptions.httpClient

loggingOptions

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

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

Valor de Propriedade

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

herdado deDefaultAzureCredentialOptions.loggingOptions

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 de Propriedade

number

herdado de DefaultAzureCredentialOptions.processTimeoutInMs

proxyOptions

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

proxyOptions?: ProxySettings

Valor de Propriedade

ProxySettings

herdado de DefaultAzureCredentialOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

Valor de Propriedade

RedirectPolicyOptions

herdado de DefaultAzureCredentialOptions.redirectOptions

retryOptions

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

retryOptions?: PipelineRetryOptions

Valor de Propriedade

PipelineRetryOptions

herdado de DefaultAzureCredentialOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Valor de Propriedade

TelemetryOptions

herdado de DefaultAzureCredentialOptions.telemetryOptions

tenantId

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

tenantId?: string

Valor de Propriedade

string

herdado de DefaultAzureCredentialOptions.tenantId

tlsOptions

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

tlsOptions?: TlsSettings

Valor de Propriedade

TlsSettings

herdado de DefaultAzureCredentialOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Valor de Propriedade

UserAgentPolicyOptions

herdado de DefaultAzureCredentialOptions.userAgentOptions