DefaultAzureCredentialResourceIdOptions interface

Pacote:

@azure/identity

Fornece opções para configurar a classe DefaultAzureCredential. Essa variação dá suporte a managedIdentityResourceId e não managedIdentityClientId, já que apenas um dos dois tem suporte.

Extends

DefaultAzureCredentialOptions

Propriedades

managedIdentityResourceId

Opcionalmente, passe uma ID de recurso a ser usada pelo ManagedIdentityCredential. Em cenários como quando identidades atribuídas pelo usuário são criadas usando um modelo do ARM, em que a ID do recurso da identidade é conhecida, mas a ID do cliente não pode ser conhecida com antecedência, esse parâmetro permite que os programas usem essas identidades atribuídas pelo usuário sem precisar primeiro determinar a ID do cliente da identidade criada.

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 atingido, como em nuvens privadas ou no Azure Stack. O processo de descoberta de instância envolve a recuperação de metadados de autoridade de https://login.microsoft.com/ 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.
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.
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.
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 a ser usada como parte da credencial. Por padrão, ele pode usar uma ID de locatário genérica, dependendo da credencial subjacente.
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

managedIdentityResourceId

Opcionalmente, passe uma ID de recurso a ser usada pelo ManagedIdentityCredential. Em cenários como quando identidades atribuídas pelo usuário são criadas usando um modelo do ARM, em que a ID do recurso da identidade é conhecida, mas a ID do cliente não pode ser conhecida com antecedência, esse parâmetro permite que os programas usem essas identidades atribuídas pelo usuário sem precisar primeiro determinar a ID do cliente da identidade criada.

managedIdentityResourceId: 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 deDefaultAzureCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Valor da propriedade

AdditionalPolicyConfig[]

herdado deDefaultAzureCredentialOptions.additionalPolicies

agent

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

agent?: Agent

Valor da propriedade

Agent

herdado dedefaultAzureCredentialOptions.agent

allowInsecureConnection

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

allowInsecureConnection?: boolean

Valor da propriedade

boolean

Herdado deDefaultAzureCredentialOptions.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 deDefaultAzureCredentialOptions.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 atingido, como em nuvens privadas ou no Azure Stack. O processo de descoberta de instância envolve a recuperação de metadados de autoridade de https://login.microsoft.com/ para validar a autoridade.

disableInstanceDiscovery?: boolean

Valor da propriedade

boolean

Herdado deDefaultAzureCredentialOptions.disableInstanceDiscovery

httpClient

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

httpClient?: HttpClient

Valor da propriedade

HttpClient

Herdado deDefaultAzureCredentialOptions.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 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 da propriedade

number

Herdado deDefaultAzureCredentialOptions.processTimeoutInMs

proxyOptions

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

proxyOptions?: ProxySettings

Valor da propriedade

ProxySettings

herdado dedefaultAzureCredentialOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

Valor da propriedade

RedirectPolicyOptions

herdado dedefaultAzureCredentialOptions.redirectOptions

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[]

Herdado deDefaultAzureCredentialOptions.requiredEnvVars

retryOptions

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

retryOptions?: PipelineRetryOptions

Valor da propriedade

PipelineRetryOptions

herdado dedefaultAzureCredentialOptions.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 deDefaultAzureCredentialOptions.telemetryOptions

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

Herdado deDefaultAzureCredentialOptions.tenantId

tlsOptions

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

tlsOptions?: TlsSettings

Valor da propriedade

TlsSettings

herdado dedefaultAzureCredentialOptions.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 deDefaultAzureCredentialOptions.userAgentOptions