Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AzureKeyCredential

Package version

A static-key-based credential that supports updating the underlying key value.

Hierarchy

  • AzureKeyCredential

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

  • Create an instance of an AzureKeyCredential for use with a service client.

    Parameters

    • key: string

      the initial value of the key to use in authentication

    Returns AzureKeyCredential

Accessors

key

  • get key(): string

Methods

update

  • update(newKey: string): void

  • Change the value of the key.

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

    Parameters

    • newKey: string

      the new key value to be used

    Returns void

Generated using TypeDoc