Skip to content

Commit 500b37d

Browse files
committed
Add receiver method, bump version, update changelog
1 parent a45336b commit 500b37d

File tree

4 files changed

+16
-3
lines changed

4 files changed

+16
-3
lines changed

api/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
66

77
## Unreleased
88

9+
## [3.1.0] - 2025-11-10
10+
11+
* Add optional receiver method to the type definition for `AzureExtensionApi`.
12+
913
## [3.0.0] - 2025-10-06
1014

1115
* Package is now a combined CJS+ESM package.

api/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

api/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@microsoft/vscode-azureresources-api",
3-
"version": "3.0.0",
3+
"version": "3.1.0",
44
"description": "Type declarations and client library for the Azure Resources extension API",
55
"repository": {
66
"type": "git",

api/src/utils/apiUtils.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@ export interface AzureExtensionApi {
1010
* The API version for this extension. It should be versioned separately from the extension and ideally remains backwards compatible.
1111
*/
1212
apiVersion: string;
13+
14+
/**
15+
* Optional endpoint which Azure client extensions should implement in order to receive an Azure Resources API session.
16+
*
17+
* @param azureResourcesCredential - The credential to use when requesting the Azure Resources API
18+
* @param clientCredential - The client verification credential initially generated by the client and passed to the Azure Resources API when requesting a new session.
19+
* This credential is used to verify that the real Azure Resources extension is the one providing back the session credential.
20+
*/
21+
receiveAzureResourcesApiSession?(azureResourcesCredential: string, clientCredential: string): void | Promise<void>;
1322
}
1423

1524
export interface GetApiOptions {

0 commit comments

Comments
 (0)