@azure/core-auth package
Classes
| AzureKeyCredential |
A static-key-based credential that supports updating the underlying key value. |
| AzureNamedKeyCredential |
A static name/key-based credential that supports updating the underlying name and key values. |
| AzureSASCredential |
A static-signature-based credential that supports updating the underlying signature value. |
Interfaces
| AccessToken |
Represents an access token with an expiration time. |
| GetTokenOptions |
Defines options for TokenCredential.getToken. |
| KeyCredential |
Represents a credential defined by a static API key. |
| NamedKeyCredential |
Represents a credential defined by a static API name and key. |
| SASCredential |
Represents a credential defined by a static shared access signature. |
| TokenCredential |
Represents a credential capable of providing an authentication token. |
| TracingContext |
An interface structurally compatible with OpenTelemetry. |
Type Aliases
| HttpMethods |
Supported HTTP methods to use when making requests. |
Functions
| is |
Tests an object to determine whether it implements KeyCredential. |
| is |
Tests an object to determine whether it implements NamedKeyCredential. |
| is |
Tests an object to determine whether it implements SASCredential. |
| is |
Tests an object to determine whether it implements TokenCredential. |
Function Details
isKeyCredential(unknown)
Tests an object to determine whether it implements KeyCredential.
function isKeyCredential(credential: unknown): credential is KeyCredentialParameters
- credential
-
unknown
The assumed KeyCredential to be tested.
Returns
credential is KeyCredential
isNamedKeyCredential(unknown)
Tests an object to determine whether it implements NamedKeyCredential.
function isNamedKeyCredential(credential: unknown): credential is NamedKeyCredentialParameters
- credential
-
unknown
The assumed NamedKeyCredential to be tested.
Returns
credential is NamedKeyCredential
isSASCredential(unknown)
Tests an object to determine whether it implements SASCredential.
function isSASCredential(credential: unknown): credential is SASCredentialParameters
- credential
-
unknown
The assumed SASCredential to be tested.
Returns
credential is SASCredential
isTokenCredential(unknown)
Tests an object to determine whether it implements TokenCredential.
function isTokenCredential(credential: unknown): credential is TokenCredentialParameters
- credential
-
unknown
The assumed TokenCredential to be tested.
Returns
credential is TokenCredential