Skip to content
Closed
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
74 changes: 74 additions & 0 deletions sdk/education/azure-mgmt-education/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,79 @@
# Release History

## 1.0.0b3 (2026-04-27)

### Features Added

- Client `EducationManagementClient` added method `send_request`
- Model `GrantDetails` added property `properties`
- Model `JoinRequestDetails` added property `properties`
- Model `LabDetails` added property `properties`
- Model `StudentDetails` added property `properties`
- Model `StudentLabDetails` added property `properties`
- Added model `GrantDetailProperties`
- Added model `JoinRequestProperties`
- Added model `LabProperties`
- Added model `ProxyResource`
- Added model `StudentLabProperties`
- Added model `StudentProperties`

### Breaking Changes

- Model `GrantDetails` deleted or renamed its instance variable `offer_cap`
- Model `GrantDetails` deleted or renamed its instance variable `effective_date`
- Model `GrantDetails` deleted or renamed its instance variable `offer_type`
- Model `GrantDetails` deleted or renamed its instance variable `expiration_date`
- Model `GrantDetails` deleted or renamed its instance variable `status`
- Model `GrantDetails` deleted or renamed its instance variable `allocated_budget`
- Model `JoinRequestDetails` deleted or renamed its instance variable `first_name`
- Model `JoinRequestDetails` deleted or renamed its instance variable `last_name`
- Model `JoinRequestDetails` deleted or renamed its instance variable `email`
- Model `JoinRequestDetails` deleted or renamed its instance variable `status`
- Model `LabDetails` deleted or renamed its instance variable `display_name`
- Model `LabDetails` deleted or renamed its instance variable `budget_per_student`
- Model `LabDetails` deleted or renamed its instance variable `description`
- Model `LabDetails` deleted or renamed its instance variable `expiration_date`
- Model `LabDetails` deleted or renamed its instance variable `effective_date`
- Model `LabDetails` deleted or renamed its instance variable `status`
- Model `LabDetails` deleted or renamed its instance variable `max_student_count`
- Model `LabDetails` deleted or renamed its instance variable `invitation_code`
- Model `LabDetails` deleted or renamed its instance variable `currency_properties_total_allocated_budget_currency`
- Model `LabDetails` deleted or renamed its instance variable `value_properties_total_allocated_budget_value`
- Model `LabDetails` deleted or renamed its instance variable `currency_properties_total_budget_currency`
- Model `LabDetails` deleted or renamed its instance variable `value_properties_total_budget_value`
- Model `StudentDetails` deleted or renamed its instance variable `first_name`
- Model `StudentDetails` deleted or renamed its instance variable `last_name`
- Model `StudentDetails` deleted or renamed its instance variable `email`
- Model `StudentDetails` deleted or renamed its instance variable `role`
- Model `StudentDetails` deleted or renamed its instance variable `budget`
- Model `StudentDetails` deleted or renamed its instance variable `subscription_id`
- Model `StudentDetails` deleted or renamed its instance variable `expiration_date`
- Model `StudentDetails` deleted or renamed its instance variable `status`
- Model `StudentDetails` deleted or renamed its instance variable `effective_date`
- Model `StudentDetails` deleted or renamed its instance variable `subscription_alias`
- Model `StudentDetails` deleted or renamed its instance variable `subscription_invite_last_sent_date`
- Model `StudentLabDetails` deleted or renamed its instance variable `display_name`
- Model `StudentLabDetails` deleted or renamed its instance variable `description`
- Model `StudentLabDetails` deleted or renamed its instance variable `expiration_date`
- Model `StudentLabDetails` deleted or renamed its instance variable `role`
- Model `StudentLabDetails` deleted or renamed its instance variable `budget`
- Model `StudentLabDetails` deleted or renamed its instance variable `subscription_id`
- Model `StudentLabDetails` deleted or renamed its instance variable `status`
- Model `StudentLabDetails` deleted or renamed its instance variable `effective_date`
- Model `StudentLabDetails` deleted or renamed its instance variable `lab_scope`
- Deleted or renamed model `GrantListResponse`
- Deleted or renamed model `JoinRequestList`
- Method `GrantsOperations.get` changed its parameter `include_allocated_budget` from `positional_or_keyword` to `keyword_only`
- Method `GrantsOperations.list` changed its parameter `include_allocated_budget` from `positional_or_keyword` to `keyword_only`
- Method `GrantsOperations.list_all` changed its parameter `include_allocated_budget` from `positional_or_keyword` to `keyword_only`
- Method `JoinRequestsOperations.list` changed its parameter `include_denied` from `positional_or_keyword` to `keyword_only`
- Method `LabsOperations.generate_invite_code` changed its parameter `only_update_student_count_parameter` from `positional_or_keyword` to `keyword_only`
- Method `LabsOperations.get` changed its parameter `include_budget` from `positional_or_keyword` to `keyword_only`
- Method `LabsOperations.list` changed its parameter `include_budget` from `positional_or_keyword` to `keyword_only`
- Method `LabsOperations.list_all` changed its parameter `include_budget` from `positional_or_keyword` to `keyword_only`
- Method `LabsOperations.list_all` changed its parameter `include_deleted` from `positional_or_keyword` to `keyword_only`
- Method `StudentsOperations.list` changed its parameter `include_deleted` from `positional_or_keyword` to `keyword_only`

## 1.0.0b2 (2022-12-12)

### Other Changes
Expand Down
9 changes: 4 additions & 5 deletions sdk/education/azure-mgmt-education/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
include _meta.json
recursive-include tests *.py *.json
recursive-include samples *.py *.md
include *.md
include azure/__init__.py
include azure/mgmt/__init__.py
include LICENSE
include azure/mgmt/education/py.typed
recursive-include tests *.py
recursive-include samples *.py *.md
include azure/__init__.py
include azure/mgmt/__init__.py
55 changes: 44 additions & 11 deletions sdk/education/azure-mgmt-education/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,61 @@
# Microsoft Azure SDK for Python

This is the Microsoft Azure Education Management Client Library.
This package has been tested with Python 3.7+.
This package has been tested with Python 3.9+.
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).

## _Disclaimer_

_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_

# Usage
## Getting started

### Prerequisites

To learn how to use this package, see the [quickstart guide](https://aka.ms/azsdk/python/mgmt)

For docs and references, see [Python SDK References](https://docs.microsoft.com/python/api/overview/azure/)
Code samples for this package can be found at [Education Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com.
Additional code samples for different Azure services are available at [Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
- Python 3.9+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package

# Provide Feedback
```bash
pip install azure-mgmt-education
pip install azure-identity
```

If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project.
### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the following environment variables.

- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
- `AZURE_CLIENT_SECRET` for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.

With above configuration, client can be authenticated by following code:

```python
from azure.identity import DefaultAzureCredential
from azure.mgmt.education import EducationManagementClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = EducationManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```

## Examples

Code samples for this package can be found at:
- [Search Education Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)


## Troubleshooting

## Next steps

## Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project.
11 changes: 0 additions & 11 deletions sdk/education/azure-mgmt-education/_meta.json

This file was deleted.

10 changes: 10 additions & 0 deletions sdk/education/azure-mgmt-education/_metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"apiVersion": "2021-12-01-preview",
"apiVersions": {
"Microsoft.Education": "2021-12-01-preview"
},
"commit": "4b44bb2ab1aae6c66f34aadd44ac7ec4436941d9",
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
"typespec_src": "specification/education/resource-manager/Microsoft.Education/Education",
"emitterVersion": "0.61.3"
}
77 changes: 77 additions & 0 deletions sdk/education/azure-mgmt-education/apiview-properties.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
{
"CrossLanguagePackageId": "Microsoft.Education",
"CrossLanguageDefinitionId": {
"azure.mgmt.education.models.Amount": "Microsoft.Education.Amount",
"azure.mgmt.education.models.ErrorResponse": "Microsoft.Education.ErrorResponse",
"azure.mgmt.education.models.ErrorResponseBody": "Microsoft.Education.ErrorResponseBody",
"azure.mgmt.education.models.GrantDetailProperties": "Microsoft.Education.GrantDetailProperties",
"azure.mgmt.education.models.Resource": "Azure.ResourceManager.CommonTypes.Resource",
"azure.mgmt.education.models.ProxyResource": "Azure.ResourceManager.CommonTypes.ProxyResource",
"azure.mgmt.education.models.GrantDetails": "Microsoft.Education.GrantDetails",
"azure.mgmt.education.models.InviteCodeGenerateRequest": "Microsoft.Education.InviteCodeGenerateRequest",
"azure.mgmt.education.models.JoinRequestDetails": "Microsoft.Education.JoinRequestDetails",
"azure.mgmt.education.models.JoinRequestProperties": "Microsoft.Education.JoinRequestProperties",
"azure.mgmt.education.models.LabDetails": "Microsoft.Education.LabDetails",
"azure.mgmt.education.models.LabProperties": "Microsoft.Education.LabProperties",
"azure.mgmt.education.models.Operation": "Azure.ResourceManager.CommonTypes.Operation",
"azure.mgmt.education.models.OperationDisplay": "Azure.ResourceManager.CommonTypes.OperationDisplay",
"azure.mgmt.education.models.OperationListResult": "Azure.ResourceManager.CommonTypes.OperationListResult",
"azure.mgmt.education.models.RedeemRequest": "Microsoft.Education.RedeemRequest",
"azure.mgmt.education.models.StudentDetails": "Microsoft.Education.StudentDetails",
"azure.mgmt.education.models.StudentLabDetails": "Microsoft.Education.StudentLabDetails",
"azure.mgmt.education.models.StudentLabProperties": "Microsoft.Education.StudentLabProperties",
"azure.mgmt.education.models.StudentProperties": "Microsoft.Education.StudentProperties",
"azure.mgmt.education.models.SystemData": "Azure.ResourceManager.CommonTypes.SystemData",
"azure.mgmt.education.models.Origin": "Azure.ResourceManager.CommonTypes.Origin",
"azure.mgmt.education.models.ActionType": "Azure.ResourceManager.CommonTypes.ActionType",
"azure.mgmt.education.models.CreatedByType": "Azure.ResourceManager.CommonTypes.createdByType",
"azure.mgmt.education.models.GrantType": "Microsoft.Education.GrantType",
"azure.mgmt.education.models.GrantStatus": "Microsoft.Education.GrantStatus",
"azure.mgmt.education.models.LabStatus": "Microsoft.Education.LabStatus",
"azure.mgmt.education.models.JoinRequestStatus": "Microsoft.Education.JoinRequestStatus",
"azure.mgmt.education.models.StudentRole": "Microsoft.Education.StudentRole",
"azure.mgmt.education.models.StudentLabStatus": "Microsoft.Education.StudentLabStatus",
"azure.mgmt.education.operations.Operations.list": "Microsoft.Education.Operations.list",
"azure.mgmt.education.aio.operations.Operations.list": "Microsoft.Education.Operations.list",
"azure.mgmt.education.operations.GrantsOperations.get": "Microsoft.Education.Grants.get",
"azure.mgmt.education.aio.operations.GrantsOperations.get": "Microsoft.Education.Grants.get",
"azure.mgmt.education.operations.GrantsOperations.list": "Microsoft.Education.Grants.list",
"azure.mgmt.education.aio.operations.GrantsOperations.list": "Microsoft.Education.Grants.list",
"azure.mgmt.education.operations.GrantsOperations.list_all": "Microsoft.Education.Grants.listAll",
"azure.mgmt.education.aio.operations.GrantsOperations.list_all": "Microsoft.Education.Grants.listAll",
"azure.mgmt.education.operations.LabsOperations.get": "Microsoft.Education.Labs.get",
"azure.mgmt.education.aio.operations.LabsOperations.get": "Microsoft.Education.Labs.get",
"azure.mgmt.education.operations.LabsOperations.create_or_update": "Microsoft.Education.Labs.createOrUpdate",
"azure.mgmt.education.aio.operations.LabsOperations.create_or_update": "Microsoft.Education.Labs.createOrUpdate",
"azure.mgmt.education.operations.LabsOperations.delete": "Microsoft.Education.Labs.delete",
"azure.mgmt.education.aio.operations.LabsOperations.delete": "Microsoft.Education.Labs.delete",
"azure.mgmt.education.operations.LabsOperations.list": "Microsoft.Education.Labs.list",
"azure.mgmt.education.aio.operations.LabsOperations.list": "Microsoft.Education.Labs.list",
"azure.mgmt.education.operations.LabsOperations.list_all": "Microsoft.Education.Labs.listAll",
"azure.mgmt.education.aio.operations.LabsOperations.list_all": "Microsoft.Education.Labs.listAll",
"azure.mgmt.education.operations.LabsOperations.generate_invite_code": "Microsoft.Education.Labs.generateInviteCode",
"azure.mgmt.education.aio.operations.LabsOperations.generate_invite_code": "Microsoft.Education.Labs.generateInviteCode",
"azure.mgmt.education.operations.JoinRequestsOperations.get": "Microsoft.Education.JoinRequests.get",
"azure.mgmt.education.aio.operations.JoinRequestsOperations.get": "Microsoft.Education.JoinRequests.get",
"azure.mgmt.education.operations.JoinRequestsOperations.list": "Microsoft.Education.JoinRequests.list",
"azure.mgmt.education.aio.operations.JoinRequestsOperations.list": "Microsoft.Education.JoinRequests.list",
"azure.mgmt.education.operations.JoinRequestsOperations.approve": "Microsoft.Education.JoinRequests.approve",
"azure.mgmt.education.aio.operations.JoinRequestsOperations.approve": "Microsoft.Education.JoinRequests.approve",
"azure.mgmt.education.operations.JoinRequestsOperations.deny": "Microsoft.Education.JoinRequests.deny",
"azure.mgmt.education.aio.operations.JoinRequestsOperations.deny": "Microsoft.Education.JoinRequests.deny",
"azure.mgmt.education.operations.StudentsOperations.get": "Microsoft.Education.Students.get",
"azure.mgmt.education.aio.operations.StudentsOperations.get": "Microsoft.Education.Students.get",
"azure.mgmt.education.operations.StudentsOperations.create_or_update": "Microsoft.Education.Students.createOrUpdate",
"azure.mgmt.education.aio.operations.StudentsOperations.create_or_update": "Microsoft.Education.Students.createOrUpdate",
"azure.mgmt.education.operations.StudentsOperations.delete": "Microsoft.Education.Students.delete",
"azure.mgmt.education.aio.operations.StudentsOperations.delete": "Microsoft.Education.Students.delete",
"azure.mgmt.education.operations.StudentsOperations.list": "Microsoft.Education.Students.list",
"azure.mgmt.education.aio.operations.StudentsOperations.list": "Microsoft.Education.Students.list",
"azure.mgmt.education.operations.StudentLabsOperations.get": "Microsoft.Education.StudentLabs.get",
"azure.mgmt.education.aio.operations.StudentLabsOperations.get": "Microsoft.Education.StudentLabs.get",
"azure.mgmt.education.operations.StudentLabsOperations.list_all": "Microsoft.Education.StudentLabs.listAll",
"azure.mgmt.education.aio.operations.StudentLabsOperations.list_all": "Microsoft.Education.StudentLabs.listAll",
"azure.mgmt.education.EducationManagementClient.redeem_invitation_code": "Microsoft.Education.redeemInvitationCode",
"azure.mgmt.education.aio.EducationManagementClient.redeem_invitation_code": "Microsoft.Education.redeemInvitationCode"
}
}
2 changes: 1 addition & 1 deletion sdk/education/azure-mgmt-education/azure/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__path__ = __import__("pkgutil").extend_path(__path__, __name__)
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__path__ = __import__("pkgutil").extend_path(__path__, __name__)
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,31 @@
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Code generated by Microsoft (R) Python Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
# pylint: disable=wrong-import-position

from ._education_management_client import EducationManagementClient
from typing import TYPE_CHECKING

if TYPE_CHECKING:
from ._patch import * # pylint: disable=unused-wildcard-import

from ._client import EducationManagementClient # type: ignore
from ._version import VERSION

__version__ = VERSION

try:
from ._patch import __all__ as _patch_all
from ._patch import * # pylint: disable=unused-wildcard-import
from ._patch import *
except ImportError:
_patch_all = []
from ._patch import patch_sdk as _patch_sdk

__all__ = [
"EducationManagementClient",
]
__all__.extend([p for p in _patch_all if p not in __all__])
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore

_patch_sdk()
Loading
Loading