DefaultAzureCredentialResourceIdOptions interface

Package:

@azure/identity

Provides options to configure the DefaultAzureCredential class. This variation supports managedIdentityResourceId and not managedIdentityClientId, since only one of both is supported.

Extends

DefaultAzureCredentialOptions

Properties

managedIdentityResourceId

Optionally pass in a resource ID to be used by the ManagedIdentityCredential. In scenarios such as when user assigned identities are created using an ARM template, where the resource Id of the identity is known but the client Id can't be known ahead of time, this parameter allows programs to use these user assigned identities without having to first determine the client Id of the created identity.

Inherited Properties

additionallyAllowedTenants	For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens. Add the wildcard value "*" to allow the credential to acquire tokens for any tenant the application is installed.
additionalPolicies	Additional policies to include in the HTTP pipeline.
allowInsecureConnection	Set to true if the request is sent over HTTP instead of HTTPS
authorityHost	The authority host to use for authentication requests. Possible values are available through AzureAuthorityHosts. The default is "https://login.microsoftonline.com".
httpClient	The HttpClient that will be used to send HTTP requests.
loggingOptions	Allows logging account information once the authentication flow succeeds.
proxyOptions	Options to configure a proxy for outgoing requests.
redirectOptions	Options for how redirect responses are handled.
retryOptions	Options that control how to retry failed requests.
tenantId	Optionally pass in a Tenant ID to be used as part of the credential. By default it may use a generic tenant ID depending on the underlying credential.
tlsOptions	Options for configuring TLS authentication
userAgentOptions	Options for adding user agent details to outgoing requests.

Property Details

managedIdentityResourceId

Optionally pass in a resource ID to be used by the ManagedIdentityCredential. In scenarios such as when user assigned identities are created using an ARM template, where the resource Id of the identity is known but the client Id can't be known ahead of time, this parameter allows programs to use these user assigned identities without having to first determine the client Id of the created identity.

managedIdentityResourceId: string

Property Value

string

Inherited Property Details

additionallyAllowedTenants

For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens. Add the wildcard value "*" to allow the credential to acquire tokens for any tenant the application is installed.

additionallyAllowedTenants?: string[]

Property Value

string[]

Inherited From MultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

Additional policies to include in the HTTP pipeline.

additionalPolicies?: AdditionalPolicyConfig[]

Property Value

AdditionalPolicyConfig[]

Inherited From CommonClientOptions.additionalPolicies

allowInsecureConnection

Set to true if the request is sent over HTTP instead of HTTPS

allowInsecureConnection?: boolean

Property Value

boolean

Inherited From CommonClientOptions.allowInsecureConnection

authorityHost

The authority host to use for authentication requests. Possible values are available through AzureAuthorityHosts. The default is "https://login.microsoftonline.com".

authorityHost?: string

Property Value

string

Inherited From TokenCredentialOptions.authorityHost

httpClient

The HttpClient that will be used to send HTTP requests.

httpClient?: HttpClient

Property Value

HttpClient

Inherited From CommonClientOptions.httpClient

loggingOptions

Allows logging account information once the authentication flow succeeds.

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean }

Property Value

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean }

Inherited From TokenCredentialOptions.loggingOptions

proxyOptions

Options to configure a proxy for outgoing requests.

proxyOptions?: ProxySettings

Property Value

ProxySettings

Inherited From PipelineOptions.proxyOptions

redirectOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectPolicyOptions

Property Value

RedirectPolicyOptions

Inherited From PipelineOptions.redirectOptions

retryOptions

Options that control how to retry failed requests.

retryOptions?: PipelineRetryOptions

Property Value

PipelineRetryOptions

Inherited From PipelineOptions.retryOptions

tenantId

Optionally pass in a Tenant ID to be used as part of the credential. By default it may use a generic tenant ID depending on the underlying credential.

tenantId?: string

Property Value

string

Inherited From DefaultAzureCredentialOptions.tenantId

tlsOptions

Options for configuring TLS authentication

tlsOptions?: TlsSettings

Property Value

TlsSettings

Inherited From PipelineOptions.tlsOptions

userAgentOptions

Options for adding user agent details to outgoing requests.

userAgentOptions?: UserAgentPolicyOptions

Property Value

UserAgentPolicyOptions

Inherited From PipelineOptions.userAgentOptions