DefaultAzureCredentialClientIdOptions interface

Paquete:

@azure/identity

Proporciona opciones para configurar la clase DefaultAzureCredential. Esta variación admite managedIdentityClientId y no managedIdentityResourceId, ya que solo se admite una de las dos.

Extends

DefaultAzureCredentialOptions

Propiedades

managedIdentityClientId	Opcionalmente, pase un identificador de cliente asignado por el usuario que va a usar el ManagedIdentityCredential. Este identificador de cliente también se puede pasar al ManagedIdentityCredential a través de la variable de entorno: AZURE_CLIENT_ID.
workloadIdentityClientId	Opcionalmente, pase un identificador de cliente asignado por el usuario que va a usar el WorkloadIdentityCredential. Este identificador de cliente también se puede pasar al workloadIdentityCredential de a través de la variable de entorno: AZURE_CLIENT_ID.

Propiedades heredadas

additionallyAllowedTenants	En el caso de las aplicaciones multiinquilino, especifica inquilinos adicionales para los que la credencial puede adquirir tokens. Agregue el valor comodín "*" para permitir que la credencial adquiera tokens para cualquier inquilino que esté instalada la aplicación.
additionalPolicies	Directivas adicionales que se van a incluir en la canalización HTTP.
agent	Opciones para configurar la instancia del agente para las solicitudes salientes
allowInsecureConnection	Establézcalo en true si la solicitud se envía a través de HTTP en lugar de HTTPS.
authorityHost	Host de autoridad que se va a usar para las solicitudes de autenticación. Los valores posibles están disponibles a través de AzureAuthorityHosts. El valor predeterminado es "https://login.microsoftonline.com".
disableInstanceDiscovery	El campo determina si se realiza la detección de instancias al intentar autenticarse. Si se establece en true deshabilitará completamente la detección de instancias y la validación de autoridad. Como resultado, es fundamental asegurarse de que el host de autoridad configurado sea válido y de confianza. Esta funcionalidad está pensada para su uso en escenarios en los que no se puede acceder al punto de conexión de metadatos, como en nubes privadas o Azure Stack. El proceso de detección de instancias implica recuperar metadatos de autoridad de https://login.microsoft.com/ para validar la autoridad.
httpClient	HttpClient que se usará para enviar solicitudes HTTP.
loggingOptions	Permite a los usuarios configurar las opciones de directiva de registro, permitir el registro de la información de la cuenta y la información de identificación personal para el soporte al cliente.
processTimeoutInMs	Tiempo de espera configurable para realizar solicitudes de token para credenciales de desarrollador, es decir, <xref:AzurePowershellCredential>, azureDeveloperCliCredential y AzureCliCredential. El tiempo de espera del proceso para las credenciales debe proporcionarse en milisegundos.
proxyOptions	Opciones para configurar un proxy para las solicitudes salientes.
redirectOptions	Opciones para controlar las respuestas de redirección.
retryOptions	Opciones que controlan cómo reintentar las solicitudes con errores.
telemetryOptions	Opciones para establecer información de seguimiento y telemetría comunes en las solicitudes salientes.
tenantId	Opcionalmente, pase un identificador de inquilino que se usará como parte de la credencial. De forma predeterminada, puede usar un identificador de inquilino genérico en función de la credencial subyacente.
tlsOptions	Opciones para configurar la autenticación TLS
userAgentOptions	Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

Detalles de las propiedades

managedIdentityClientId

Opcionalmente, pase un identificador de cliente asignado por el usuario que va a usar el ManagedIdentityCredential. Este identificador de cliente también se puede pasar al ManagedIdentityCredential a través de la variable de entorno: AZURE_CLIENT_ID.

managedIdentityClientId?: string

Valor de propiedad

string

workloadIdentityClientId

Opcionalmente, pase un identificador de cliente asignado por el usuario que va a usar el WorkloadIdentityCredential. Este identificador de cliente también se puede pasar al workloadIdentityCredential de a través de la variable de entorno: AZURE_CLIENT_ID.

workloadIdentityClientId?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

additionallyAllowedTenants

En el caso de las aplicaciones multiinquilino, especifica inquilinos adicionales para los que la credencial puede adquirir tokens. Agregue el valor comodín "*" para permitir que la credencial adquiera tokens para cualquier inquilino que esté instalada la aplicación.

additionallyAllowedTenants?: string[]

Valor de propiedad

string[]

heredado dedefaultAzureCredentialOptions.additionallyAllowedTenants

additionalPolicies

Directivas adicionales que se van a incluir en la canalización HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor de propiedad

AdditionalPolicyConfig[]

heredado dedefaultAzureCredentialOptions.additionalPolicies

agent

Opciones para configurar la instancia del agente para las solicitudes salientes

agent?: Agent

Valor de propiedad

Agent

heredado dedefaultAzureCredentialOptions.agent

allowInsecureConnection

Establézcalo en true si la solicitud se envía a través de HTTP en lugar de HTTPS.

allowInsecureConnection?: boolean

Valor de propiedad

boolean

heredado dedefaultAzureCredentialOptions.allowInsecureConnection

authorityHost

Host de autoridad que se va a usar para las solicitudes de autenticación. Los valores posibles están disponibles a través de AzureAuthorityHosts. El valor predeterminado es "https://login.microsoftonline.com".

authorityHost?: string

Valor de propiedad

string

heredado dedefaultAzureCredentialOptions.authorityHost

disableInstanceDiscovery

El campo determina si se realiza la detección de instancias al intentar autenticarse. Si se establece en true deshabilitará completamente la detección de instancias y la validación de autoridad. Como resultado, es fundamental asegurarse de que el host de autoridad configurado sea válido y de confianza. Esta funcionalidad está pensada para su uso en escenarios en los que no se puede acceder al punto de conexión de metadatos, como en nubes privadas o Azure Stack. El proceso de detección de instancias implica recuperar metadatos de autoridad de https://login.microsoft.com/ para validar la autoridad.

disableInstanceDiscovery?: boolean

Valor de propiedad

boolean

heredado dedefaultAzureCredentialOptions.disableInstanceDiscovery

httpClient

HttpClient que se usará para enviar solicitudes HTTP.

httpClient?: HttpClient

Valor de propiedad

HttpClient

heredado dedefaultAzureCredentialOptions.httpClient

loggingOptions

Permite a los usuarios configurar las opciones de directiva de registro, permitir el registro de la información de la cuenta y la información de identificación personal para el soporte al cliente.

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

Valor de propiedad

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

heredado dedefaultAzureCredentialOptions.loggingOptions

processTimeoutInMs

Tiempo de espera configurable para realizar solicitudes de token para credenciales de desarrollador, es decir, <xref:AzurePowershellCredential>, azureDeveloperCliCredential y AzureCliCredential. El tiempo de espera del proceso para las credenciales debe proporcionarse en milisegundos.

processTimeoutInMs?: number

Valor de propiedad

number

heredado dedefaultAzureCredentialOptions.processTimeoutInMs

proxyOptions

Opciones para configurar un proxy para las solicitudes salientes.

proxyOptions?: ProxySettings

Valor de propiedad

ProxySettings

heredado dedefaultAzureCredentialOptions.proxyOptions

redirectOptions

Opciones para controlar las respuestas de redirección.

redirectOptions?: RedirectPolicyOptions

Valor de propiedad

RedirectPolicyOptions

heredado dedefaultAzureCredentialOptions.redirectOptions

retryOptions

Opciones que controlan cómo reintentar las solicitudes con errores.

retryOptions?: PipelineRetryOptions

Valor de propiedad

PipelineRetryOptions

Heredado dedefaultAzureCredentialOptions.retryOptions

telemetryOptions

Opciones para establecer información de seguimiento y telemetría comunes en las solicitudes salientes.

telemetryOptions?: TelemetryOptions

Valor de propiedad

TelemetryOptions

heredado dedefaultAzureCredentialOptions.telemetryOptions

tenantId

Opcionalmente, pase un identificador de inquilino que se usará como parte de la credencial. De forma predeterminada, puede usar un identificador de inquilino genérico en función de la credencial subyacente.

tenantId?: string

Valor de propiedad

string

heredado dedefaultAzureCredentialOptions.tenantId

tlsOptions

Opciones para configurar la autenticación TLS

tlsOptions?: TlsSettings

Valor de propiedad

TlsSettings

heredado dedefaultAzureCredentialOptions.tlsOptions

userAgentOptions

Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

userAgentOptions?: UserAgentPolicyOptions

Valor de propiedad

UserAgentPolicyOptions

Se hereda dedefaultAzureCredentialOptions.userAgentOptions