Share via

AzureNamedKeyCredential class

  • Reference
Package:
@azure/core-auth

A static name/key-based credential that supports updating the underlying name and key values.

Constructors

AzureNamedKeyCredential(string, string)

Create an instance of an AzureNamedKeyCredential for use with a service client.

Properties

key

The value of the key to be used in authentication.
name

The value of the name to be used in authentication.

Methods

update(string, string)

Change the value of the key.

Updates will take effect upon the next request after updating the key value.

Constructor Details

AzureNamedKeyCredential(string, string)

Create an instance of an AzureNamedKeyCredential for use with a service client.

new AzureNamedKeyCredential(name: string, key: string)

Parameters

name

string

The initial value of the name to use in authentication.

key

string

The initial value of the key to use in authentication.

Property Details

key

The value of the key to be used in authentication.

string key

Property Value

string

name

The value of the name to be used in authentication.

string name

Property Value

string

Method Details

update(string, string)

Change the value of the key.

Updates will take effect upon the next request after updating the key value.

function update(newName: string, newKey: string)

Parameters

newName

string

The new name value to be used.

newKey

string

The new key value to be used.