DefaultAzureCredentialClientIdOptions interface

Pacote:

@azure/identity

Fornece opções para configurar a classe DefaultAzureCredential . Esta variação suporta managedIdentityClientId e não managedIdentityResourceId, uma vez que apenas uma de ambas é suportada.

Extends

DefaultAzureCredentialOptions

Propriedades

managedIdentityClientId	Opcionalmente, transmita um ID de cliente atribuído pelo utilizador para ser utilizado pelo ManagedIdentityCredential. Este ID de cliente também pode ser transmitido para o ManagedIdentityCredential através da variável de ambiente: AZURE_CLIENT_ID.
workloadIdentityClientId	Opcionalmente, transmita um ID de cliente atribuído ao utilizador para ser utilizado pelo WorkloadIdentityCredential. Este ID de cliente também pode ser transmitido para WorkloadIdentityCredential através da variável de ambiente: AZURE_CLIENT_ID.

Propriedades Herdadas

additionallyAllowedTenants	Para aplicações multi-inquilino, especifica inquilinos adicionais para os quais a credencial pode adquirir tokens. Adicione o valor universal "*" para permitir que a credencial adquira tokens para qualquer inquilino que a aplicação esteja instalada.
additionalPolicies	Políticas adicionais a incluir no pipeline HTTP.
allowInsecureConnection	Defina como verdadeiro se o pedido for enviado através de HTTP em vez de HTTPS
authorityHost	O anfitrião de autoridade a utilizar para pedidos de autenticação. Os valores possíveis estão disponíveis através do AzureAuthorityHosts. A predefinição é "https://login.microsoftonline.com".
disableInstanceDiscovery	O campo determina se a deteção de instâncias é efetuada ao tentar autenticar. Definir isto como true irá desativar completamente a deteção de instâncias e a validação da autoridade. Como resultado, é crucial garantir que o anfitrião de autoridade configurado é válido e fidedigno. Esta funcionalidade destina-se a ser utilizada em cenários em que não é possível alcançar o ponto final de metadados, como em clouds privadas ou no Azure Stack. O processo de deteção de instâncias implica a obtenção de metadados de autoridade para https://login.microsoft.com/ validar a autoridade.
httpClient	O HttpClient que será utilizado para enviar pedidos HTTP.
loggingOptions	Permite que os utilizadores configurem definições para opções de política de registo, permitir informações de conta de registo e informações pessoalmente identificáveis para o suporte ao cliente.
processTimeoutInMs	Tempo limite configurável para fazer pedidos de token para credenciais de programador, nomeadamente, <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 pedidos de saída.
redirectOptions	Opções para a forma como as respostas de redirecionamento são processadas.
retryOptions	Opções que controlam como repetir pedidos falhados.
telemetryOptions	Opções para definir informações comuns de telemetria e rastreio para pedidos enviados.
tenantId	Opcionalmente, transmita um ID de Inquilino para ser utilizado como parte da credencial. Por predefinição, pode utilizar um ID de inquilino genérico consoante a credencial subjacente.
tlsOptions	Opções para configurar a autenticação TLS
userAgentOptions	Opções para adicionar detalhes do agente de utilizador aos pedidos enviados.

Detalhes de Propriedade

managedIdentityClientId

Opcionalmente, transmita um ID de cliente atribuído pelo utilizador para ser utilizado pelo ManagedIdentityCredential. Este ID de cliente também pode ser transmitido para o ManagedIdentityCredential através da variável de ambiente: AZURE_CLIENT_ID.

managedIdentityClientId?: string

Valor de Propriedade

string

workloadIdentityClientId

Opcionalmente, transmita um ID de cliente atribuído ao utilizador para ser utilizado pelo WorkloadIdentityCredential. Este ID de cliente também pode ser transmitido para WorkloadIdentityCredential através da variável de ambiente: AZURE_CLIENT_ID.

workloadIdentityClientId?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

additionallyAllowedTenants

Para aplicações multi-inquilino, especifica inquilinos adicionais para os quais a credencial pode adquirir tokens. Adicione o valor universal "*" para permitir que a credencial adquira tokens para qualquer inquilino que a aplicação esteja instalada.

additionallyAllowedTenants?: string[]

Valor de Propriedade

string[]

Herdado deDefaultAzureCredentialOptions.additionallyAllowedTenants

additionalPolicies

Políticas adicionais a incluir no pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor de Propriedade

AdditionalPolicyConfig[]

Herdado deDefaultAzureCredentialOptions.additionalPolicies

allowInsecureConnection

Defina como verdadeiro se o pedido for enviado através de HTTP em vez de HTTPS

allowInsecureConnection?: boolean

Valor de Propriedade

boolean

Herdado deDefaultAzureCredentialOptions.allowInsecureConnection

authorityHost

O anfitrião de autoridade a utilizar para pedidos de autenticação. Os valores possíveis estão disponíveis através do AzureAuthorityHosts. A predefinição é "https://login.microsoftonline.com".

authorityHost?: string

Valor de Propriedade

string

Herdado deDefaultAzureCredentialOptions.authorityHost

disableInstanceDiscovery

O campo determina se a deteção de instâncias é efetuada ao tentar autenticar. Definir isto como true irá desativar completamente a deteção de instâncias e a validação da autoridade. Como resultado, é crucial garantir que o anfitrião de autoridade configurado é válido e fidedigno. Esta funcionalidade destina-se a ser utilizada em cenários em que não é possível alcançar o ponto final de metadados, como em clouds privadas ou no Azure Stack. O processo de deteção de instâncias implica a obtenção de metadados de autoridade para https://login.microsoft.com/ validar a autoridade.

disableInstanceDiscovery?: boolean

Valor de Propriedade

boolean

Herdado deDefaultAzureCredentialOptions.disableInstanceDiscovery

httpClient

O HttpClient que será utilizado para enviar pedidos HTTP.

httpClient?: HttpClient

Valor de Propriedade

HttpClient

Herdado deDefaultAzureCredentialOptions.httpClient

loggingOptions

Permite que os utilizadores configurem definições para opções de política de registo, permitir informações de conta de registo e informações pessoalmente identificáveis para o 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 pedidos de token para credenciais de programador, nomeadamente, <xref:AzurePowershellCredential>, AzureDeveloperCliCredential e AzureCliCredential. O tempo limite do processo para credenciais deve ser fornecido em milissegundos.

processTimeoutInMs?: number

Valor de Propriedade

number

Herdado deDefaultAzureCredentialOptions.processTimeoutInMs

proxyOptions

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

proxyOptions?: ProxySettings

Valor de Propriedade

ProxySettings

Herdado deDefaultAzureCredentialOptions.proxyOptions

redirectOptions

Opções para a forma como as respostas de redirecionamento são processadas.

redirectOptions?: RedirectPolicyOptions

Valor de Propriedade

RedirectPolicyOptions

Herdado deDefaultAzureCredentialOptions.redirectOptions

retryOptions

Opções que controlam como repetir pedidos falhados.

retryOptions?: PipelineRetryOptions

Valor de Propriedade

PipelineRetryOptions

Herdado deDefaultAzureCredentialOptions.retryOptions

telemetryOptions

Opções para definir informações comuns de telemetria e rastreio para pedidos enviados.

telemetryOptions?: TelemetryOptions

Valor de Propriedade

TelemetryOptions

Herdado deDefaultAzureCredentialOptions.telemetryOptions

tenantId

Opcionalmente, transmita um ID de Inquilino para ser utilizado como parte da credencial. Por predefinição, pode utilizar um ID de inquilino genérico consoante a credencial subjacente.

tenantId?: string

Valor de Propriedade

string

Herdado deDefaultAzureCredentialOptions.tenantId

tlsOptions

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

tlsOptions?: TlsSettings

Valor de Propriedade

TlsSettings

Herdado deDefaultAzureCredentialOptions.tlsOptions

userAgentOptions

Opções para adicionar detalhes do agente de utilizador aos pedidos enviados.

userAgentOptions?: UserAgentPolicyOptions

Valor de Propriedade

UserAgentPolicyOptions

Herdado deDefaultAzureCredentialOptions.userAgentOptions