Class EventGridSharedAccessSignatureCredential

Package version

A credential type which allows using a "shared access signature" to authenticate with EventGrid when sending events.

A shared access signiture may be generated by using EventGridPublisherClient#generateSharedAccessSignature

Hierarchy

EventGridSharedAccessSignatureCredential

Implements

SignatureCredential

Index

Constructors

constructor

Methods

Constructors

constructor

new EventGridSharedAccessSignatureCredential(signature: string): EventGridSharedAccessSignatureCredential

- Defined in sharedAccessSignitureCredential.ts:28
Create an instance of an EventGridSharedAccessSignatureCredential for use with a service client.

Parameters
- signature: string
  
  the signature to use in authentication
Returns EventGridSharedAccessSignatureCredential

Methods

signature

signature(): string

Implementation of SignatureCredential.signature
- Defined in sharedAccessSignitureCredential.ts:26
The value of the signature to be used in authentication

Returns string

update

update(newSignature: string): void

- Defined in sharedAccessSignitureCredential.ts:52
Change the value of the signature.

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

Parameters
- newSignature: string
  
  the new signature value to be used
Returns void

Generated using TypeDoc