@azure/eventgrid
Version:
An isomorphic client library for the Azure Event Grid service.
19 lines • 1.14 kB
TypeScript
import type { KeyCredential } from "@azure/core-auth";
export interface GenerateSharedAccessSignatureOptions {
/**
* The API Version to include in the signature. If not provided, the default
* API version will be used.
*/
apiVersion?: string;
}
/**
* Generate a shared access signature, which allows a client to send events to an Event Grid Topic or Domain for a limited period of time. This
* function may only be called when the EventGridPublisherClient was constructed with a KeyCredential instance.
*
* @param endpointUrl - The endpoint for the topic or domain you wish to generate a shared access signature for.
* @param credential - The credential to use when generating the shared access signatrue.
* @param expiresOn - The time at which the shared access signature is no longer valid.
* @param options - Options to control how the signature is generated.
*/
export declare function generateSharedAccessSignature(endpointUrl: string, credential: KeyCredential, expiresOnUtc: Date, options?: GenerateSharedAccessSignatureOptions): Promise<string>;
//# sourceMappingURL=generateSharedAccessSignature.d.ts.map