Package version:

Class AzureNamedKeyCredential

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

Implements

NamedKeyCredential

Index

Constructors

Accessors

Methods

Constructors

constructor

new AzureNamedKeyCredential(name, key): AzureNamedKeyCredential
Create an instance of an AzureNamedKeyCredential for use with a service client.
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.
Returns AzureNamedKeyCredential
- Defined in azureNamedKeyCredential.ts:49

Accessors

key

get key(): string
The value of the key to be used in authentication.

Returns string
Implementation of NamedKeyCredential.key
- Defined in azureNamedKeyCredential.ts:31

name

get name(): string
The value of the name to be used in authentication.

Returns string
Implementation of NamedKeyCredential.name
- Defined in azureNamedKeyCredential.ts:38

Methods

update

update(newName, newKey): void
Change the value of the key.

Updates will take effect upon the next request after updating the key value.
Parameters
- newName: string
  The new name value to be used.
- newKey: string
  The new key value to be used.
Returns void
- Defined in azureNamedKeyCredential.ts:67