Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 24 additions & 12 deletions sdk/education/arm-education/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,33 @@
# Release History

## 1.0.0-beta.5 (Unreleased)
## 1.0.0-beta.5 (2026-05-27)
Compared with version 1.0.0-beta.3
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔴 Tool IssueCHANGELOG.md:4
Compared with version 1.0.0-beta.3.
The API version introduced in this PR is 2021-12-01-preview, which is the same as the API version already used in the existing package (1.0.0-beta.3 was also generated from 2021-12-01-preview). The api-version must be strictly newer than the one already present in the package.
Fix: Update the specification to use a newer API version (e.g., 2022-xx-xx or later) and trigger SDK regeneration. If this is an intentional re-generation refresh without an API version bump, please confirm with the spec team and report the issue in the generation tool repository.


### Features Added
- Added Interface GrantDetailProperties
- Added Interface JoinRequestProperties
- Added Interface LabProperties
- Added Interface PagedAsyncIterableIterator
- Added Interface PageSettings
- Added Interface ProxyResource
- Added Interface StudentLabProperties
- Added Interface StudentProperties
- Interface LabDetails has a new optional parameter totalAllocatedBudget
- Interface LabDetails has a new optional parameter totalBudget
- Added Type Alias AzureSupportedClouds
- Added Enum AzureClouds
- Added Enum KnownVersions

### Breaking Changes
- Removed Interface GrantListResponse
- Removed Interface JoinRequestList
- Interface LabDetails no longer has parameter currencyPropertiesTotalAllocatedBudgetCurrency
- Interface LabDetails no longer has parameter currencyPropertiesTotalBudgetCurrency
- Interface LabDetails no longer has parameter valuePropertiesTotalAllocatedBudgetValue
- Interface LabDetails no longer has parameter valuePropertiesTotalBudgetValue
- Parameter value of interface OperationListResult is now required

### Bugs Fixed

### Other Changes

## 1.0.0-beta.4 (2025-08-22)

### Other Changes

- Other fixes


## 1.0.0-beta.3 (2023-01-10)

### Features Added
Expand Down Expand Up @@ -43,4 +55,4 @@

## 1.0.0-beta.1 (2022-05-24)

The package of @azure/arm-education is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart ).
The package of @azure/arm-education is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart).
2 changes: 1 addition & 1 deletion sdk/education/arm-education/LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
27 changes: 11 additions & 16 deletions sdk/education/arm-education/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f

Education client provides access to education resources for Azure subscriptions.

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/education/arm-education) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-education) |
[API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-education?view=azure-node-preview) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)
Key links:

- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/education/arm-education)
- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-education)
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-education?view=azure-node-preview)
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/education/arm-education/samples)

## Getting started

Expand Down Expand Up @@ -35,7 +37,7 @@ npm install @azure/arm-education
To create a client object to access the Azure EducationManagement API, you will need the `endpoint` of your Azure EducationManagement resource and a `credential`. The Azure EducationManagement client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure EducationManagement resource in the [Azure Portal][azure_portal].

You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).
You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).

To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:

Expand All @@ -44,7 +46,6 @@ npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure EducationManagement** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.

For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

Expand All @@ -54,8 +55,7 @@ Using Node.js and Node-like environments, you can use the `DefaultAzureCredentia
import { EducationManagementClient } from "@azure/arm-education";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new EducationManagementClient(new DefaultAzureCredential(), subscriptionId);
const client = new EducationManagementClient(new DefaultAzureCredential());
```

For browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate.
Expand All @@ -64,16 +64,15 @@ For browser environments, use the `InteractiveBrowserCredential` from the `@azur
import { InteractiveBrowserCredential } from "@azure/identity";
import { EducationManagementClient } from "@azure/arm-education";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
const client = new EducationManagementClient(credential, subscriptionId);
const client = new EducationManagementClient(credential);
```

### JavaScript Bundle

### JavaScript Bundle
To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).

## Key concepts
Expand All @@ -98,7 +97,7 @@ For more detailed instructions on how to enable logs, you can look at the [@azur

## Next steps

Please take a look at the [samples](https://github.com/Azure-Samples/azure-samples-js-management) directory for detailed examples on how to use this library.
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/education/arm-education/samples) directory for detailed examples on how to use this library.

## Contributing

Expand All @@ -108,10 +107,6 @@ If you'd like to contribute to this library, please read the [contributing guide

- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)



[azure_cli]: https://learn.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
[azure_portal]: https://portal.azure.com
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
Expand Down
8 changes: 0 additions & 8 deletions sdk/education/arm-education/_meta.json

This file was deleted.

4 changes: 1 addition & 3 deletions sdk/education/arm-education/api-extractor.json
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
{
"extends": "../../../api-extractor-base.json"
}
{ "extends": "../../../api-extractor-base.json" }
2 changes: 1 addition & 1 deletion sdk/education/arm-education/assets.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"AssetsRepo": "Azure/azure-sdk-assets",
"AssetsRepoPrefixPath": "js",
"TagPrefix": "js/education/arm-education",
"Tag": "js/education/arm-education_2ea0c101ca"
"Tag": "js/education/arm-education_8498838361"
}
4 changes: 1 addition & 3 deletions sdk/education/arm-education/config/tsconfig.samples.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
"extends": "../../../../eng/tsconfigs/samples.json",
"compilerOptions": {
"paths": {
"@azure/arm-education": [
"../dist/esm"
]
"@azure/arm-education": ["../dist/esm"]
}
}
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"extends": "../../../../eng/tsconfigs/src.browser.json",
"include": [
"../src/index.ts"
]
"include": ["../src/index.ts"]
}
4 changes: 1 addition & 3 deletions sdk/education/arm-education/config/tsconfig.src.cjs.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"extends": "../../../../eng/tsconfigs/src.cjs.json",
"include": [
"../src/index.ts"
]
"include": ["../src/index.ts"]
}
4 changes: 1 addition & 3 deletions sdk/education/arm-education/config/tsconfig.src.esm.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"extends": "../../../../eng/tsconfigs/src.esm.json",
"include": [
"../src/index.ts"
]
"include": ["../src/index.ts"]
}
10 changes: 10 additions & 0 deletions sdk/education/arm-education/config/tsconfig.test.browser.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"extends": "../../../../eng/tsconfigs/test.browser.json",
"compilerOptions": {
"paths": {
"@azure/arm-education": ["../src/index.ts"],
"@azure/arm-education/*": ["../src/*"],
"$internal/*": ["../src/*"]
}
}
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
{
"extends": "../../../../eng/tsconfigs/test.node.json"
"extends": "../../../../eng/tsconfigs/test.node.json",
"compilerOptions": {
"paths": {
"@azure/arm-education": ["../src/index.ts"],
"@azure/arm-education/*": ["../src/*"],
"$internal/*": ["../src/*"]
}
}
}
6 changes: 3 additions & 3 deletions sdk/education/arm-education/eslint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ export default [
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
"@azure/azure-sdk/ts-package-json-files-required": "off",
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
"tsdoc/syntax": "warn"
}
}
"tsdoc/syntax": "warn",
},
},
]),
{
files: ["src/**/*.ts", "src/**/*.mts", "test/**/*.ts"],
Expand Down
68 changes: 68 additions & 0 deletions sdk/education/arm-education/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
{
"apiVersions": {
"Microsoft.Education": "2021-12-01-preview"
},
"emitterVersion": "0.53.3",
"crossLanguageDefinitions": {
"CrossLanguagePackageId": "Microsoft.Education",
"CrossLanguageDefinitionId": {
"@azure/arm-education!RedeemRequest:interface": "Microsoft.Education.RedeemRequest",
"@azure/arm-education!ErrorResponseBody:interface": "Microsoft.Education.ErrorResponseBody",
"@azure/arm-education!ErrorResponse:interface": "Microsoft.Education.ErrorResponse",
"@azure/arm-education!OperationListResult:interface": "Azure.ResourceManager.CommonTypes.OperationListResult",
"@azure/arm-education!Operation:interface": "Azure.ResourceManager.CommonTypes.Operation",
"@azure/arm-education!OperationDisplay:interface": "Azure.ResourceManager.CommonTypes.OperationDisplay",
"@azure/arm-education!GrantDetails:interface": "Microsoft.Education.GrantDetails",
"@azure/arm-education!GrantDetailProperties:interface": "Microsoft.Education.GrantDetailProperties",
"@azure/arm-education!Amount:interface": "Microsoft.Education.Amount",
"@azure/arm-education!ProxyResource:interface": "Azure.ResourceManager.CommonTypes.ProxyResource",
"@azure/arm-education!Resource:interface": "Azure.ResourceManager.CommonTypes.Resource",
"@azure/arm-education!SystemData:interface": "Azure.ResourceManager.CommonTypes.SystemData",
"@azure/arm-education!GrantListResponse:interface": "Microsoft.Education.GrantListResponse",
"@azure/arm-education!LabDetails:interface": "Microsoft.Education.LabDetails",
"@azure/arm-education!LabProperties:interface": "Microsoft.Education.LabProperties",
"@azure/arm-education!LabListResult:interface": "Microsoft.Education.LabListResult",
"@azure/arm-education!InviteCodeGenerateRequest:interface": "Microsoft.Education.InviteCodeGenerateRequest",
"@azure/arm-education!JoinRequestDetails:interface": "Microsoft.Education.JoinRequestDetails",
"@azure/arm-education!JoinRequestProperties:interface": "Microsoft.Education.JoinRequestProperties",
"@azure/arm-education!JoinRequestList:interface": "Microsoft.Education.JoinRequestList",
"@azure/arm-education!StudentDetails:interface": "Microsoft.Education.StudentDetails",
"@azure/arm-education!StudentProperties:interface": "Microsoft.Education.StudentProperties",
"@azure/arm-education!StudentListResult:interface": "Microsoft.Education.StudentListResult",
"@azure/arm-education!StudentLabDetails:interface": "Microsoft.Education.StudentLabDetails",
"@azure/arm-education!StudentLabProperties:interface": "Microsoft.Education.StudentLabProperties",
"@azure/arm-education!StudentLabListResult:interface": "Microsoft.Education.StudentLabListResult",
"@azure/arm-education!KnownOrigin:enum": "Azure.ResourceManager.CommonTypes.Origin",
"@azure/arm-education!KnownActionType:enum": "Azure.ResourceManager.CommonTypes.ActionType",
"@azure/arm-education!KnownGrantType:enum": "Microsoft.Education.GrantType",
"@azure/arm-education!KnownGrantStatus:enum": "Microsoft.Education.GrantStatus",
"@azure/arm-education!KnowncreatedByType:enum": "Azure.ResourceManager.CommonTypes.createdByType",
"@azure/arm-education!KnownLabStatus:enum": "Microsoft.Education.LabStatus",
"@azure/arm-education!KnownJoinRequestStatus:enum": "Microsoft.Education.JoinRequestStatus",
"@azure/arm-education!KnownStudentRole:enum": "Microsoft.Education.StudentRole",
"@azure/arm-education!KnownStudentLabStatus:enum": "Microsoft.Education.StudentLabStatus",
"@azure/arm-education!KnownVersions:enum": "Microsoft.Education.Versions",
"@azure/arm-education!EducationManagementClient#redeemInvitationCode:member(1)": "Microsoft.Education.redeemInvitationCode",
"@azure/arm-education!StudentLabsOperations#listAll:member": "Microsoft.Education.StudentLabs.listAll",
"@azure/arm-education!StudentLabsOperations#get:member": "Microsoft.Education.StudentLabs.get",
"@azure/arm-education!StudentsOperations#list:member": "Microsoft.Education.Students.list",
"@azure/arm-education!StudentsOperations#delete:member": "Microsoft.Education.Students.delete",
"@azure/arm-education!StudentsOperations#createOrUpdate:member": "Microsoft.Education.Students.createOrUpdate",
"@azure/arm-education!StudentsOperations#get:member": "Microsoft.Education.Students.get",
"@azure/arm-education!JoinRequestsOperations#deny:member": "Microsoft.Education.JoinRequests.deny",
"@azure/arm-education!JoinRequestsOperations#approve:member": "Microsoft.Education.JoinRequests.approve",
"@azure/arm-education!JoinRequestsOperations#list:member": "Microsoft.Education.JoinRequests.list",
"@azure/arm-education!JoinRequestsOperations#get:member": "Microsoft.Education.JoinRequests.get",
"@azure/arm-education!LabsOperations#generateInviteCode:member": "Microsoft.Education.Labs.generateInviteCode",
"@azure/arm-education!LabsOperations#listAll:member": "Microsoft.Education.Labs.listAll",
"@azure/arm-education!LabsOperations#list:member": "Microsoft.Education.Labs.list",
"@azure/arm-education!LabsOperations#delete:member": "Microsoft.Education.Labs.delete",
"@azure/arm-education!LabsOperations#createOrUpdate:member": "Microsoft.Education.Labs.createOrUpdate",
"@azure/arm-education!LabsOperations#get:member": "Microsoft.Education.Labs.get",
"@azure/arm-education!GrantsOperations#listAll:member": "Microsoft.Education.Grants.listAll",
"@azure/arm-education!GrantsOperations#list:member": "Microsoft.Education.Grants.list",
"@azure/arm-education!GrantsOperations#get:member": "Microsoft.Education.Grants.get",
"@azure/arm-education!OperationsOperations#list:member": "Microsoft.Education.Operations.list"
}
}
}
Loading
Loading