Grants - List All

Service:: Education

API Version:: 2021-12-01-preview

Get a list of grants that Microsoft has provided.

GET https://management.azure.com/providers/Microsoft.Education/grants?api-version=2021-12-01-preview

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Education/grants?includeAllocatedBudget={includeAllocatedBudget}&api-version=2021-12-01-preview

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	Version of the API to be used with the client request. Current version is 2021-12-01-preview
includeAllocatedBudget	query		boolean	May be used to include information about budget that has been allocated.

Responses

Name	Type	Description
200 OK	GrantListResponse	list of Grants
Other Status Codes	ErrorResponseBody	Describes the error if the operation is not successful.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

GrantList

GrantListIncludeAllocatedBudget

GrantList

Sample request

GET https://management.azure.com/providers/Microsoft.Education/grants?includeAllocatedBudget=False&api-version=2021-12-01-preview


/**
 * Samples for Grants ListAll.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/GrantList.json
     */
    /**
     * Sample code: GrantList.
     * 
     * @param manager Entry point to EducationManager.
     */
    public static void grantList(com.azure.resourcemanager.education.EducationManager manager) {
        manager.grants().listAll(false, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.education import EducationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-education
# USAGE
    python grant_list.py

    Before run the sample, please 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 info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EducationManagementClient(
        credential=DefaultAzureCredential(),
    )

    response = client.grants.list_all()
    for item in response:
        print(item)


# x-ms-original-file: specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/GrantList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armeducation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/education/armeducation"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b9b91929c304f8fb44002267b6c98d9fb9dde014/specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/GrantList.json
func ExampleGrantsClient_NewListAllPager_grantList() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeducation.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewGrantsClient().NewListAllPager(&armeducation.GrantsClientListAllOptions{IncludeAllocatedBudget: to.Ptr(false)})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.GrantListResponse = armeducation.GrantListResponse{
		// 	Value: []*armeducation.GrantDetails{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Education/Grants"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Education/grants/default"),
		// 			Properties: &armeducation.GrantDetailProperties{
		// 				EffectiveDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-09T09:08:05.505Z"); return t}()),
		// 				ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-09T09:08:05.505Z"); return t}()),
		// 				OfferCap: &armeducation.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](1000),
		// 				},
		// 				OfferType: to.Ptr(armeducation.GrantTypeAcademic),
		// 				Status: to.Ptr(armeducation.GrantStatusActive),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { EducationManagementClient } = require("@azure/arm-education");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a list of grants that Microsoft has provided.
 *
 * @summary Get a list of grants that Microsoft has provided.
 * x-ms-original-file: specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/GrantList.json
 */
async function grantList() {
  const includeAllocatedBudget = false;
  const options = { includeAllocatedBudget };
  const credential = new DefaultAzureCredential();
  const client = new EducationManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.grants.listAll(options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Education/grants/default",
      "name": "default",
      "type": "Microsoft.Education/Grants",
      "properties": {
        "offerCap": {
          "currency": "USD",
          "value": 1000
        },
        "effectiveDate": "2021-11-09T09:08:05.505Z",
        "offerType": "Academic",
        "expirationDate": "2021-11-09T09:08:05.505Z",
        "status": "Active"
      }
    }
  ]
}

GrantListIncludeAllocatedBudget

Sample request

GET https://management.azure.com/providers/Microsoft.Education/grants?includeAllocatedBudget=True&api-version=2021-12-01-preview


/**
 * Samples for Grants ListAll.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/
     * GrantListIncludeAllocatedBudget.json
     */
    /**
     * Sample code: GrantListIncludeAllocatedBudget.
     * 
     * @param manager Entry point to EducationManager.
     */
    public static void grantListIncludeAllocatedBudget(com.azure.resourcemanager.education.EducationManager manager) {
        manager.grants().listAll(true, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.education import EducationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-education
# USAGE
    python grant_list_include_allocated_budget.py

    Before run the sample, please 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 info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EducationManagementClient(
        credential=DefaultAzureCredential(),
    )

    response = client.grants.list_all()
    for item in response:
        print(item)


# x-ms-original-file: specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/GrantListIncludeAllocatedBudget.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armeducation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/education/armeducation"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b9b91929c304f8fb44002267b6c98d9fb9dde014/specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/GrantListIncludeAllocatedBudget.json
func ExampleGrantsClient_NewListAllPager_grantListIncludeAllocatedBudget() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeducation.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewGrantsClient().NewListAllPager(&armeducation.GrantsClientListAllOptions{IncludeAllocatedBudget: to.Ptr(true)})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.GrantListResponse = armeducation.GrantListResponse{
		// 	Value: []*armeducation.GrantDetails{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Education/Grants"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Education/grants/default"),
		// 			Properties: &armeducation.GrantDetailProperties{
		// 				AllocatedBudget: &armeducation.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				EffectiveDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-09T09:08:05.505Z"); return t}()),
		// 				ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-09T09:08:05.505Z"); return t}()),
		// 				OfferCap: &armeducation.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](1000),
		// 				},
		// 				OfferType: to.Ptr(armeducation.GrantTypeAcademic),
		// 				Status: to.Ptr(armeducation.GrantStatusActive),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { EducationManagementClient } = require("@azure/arm-education");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a list of grants that Microsoft has provided.
 *
 * @summary Get a list of grants that Microsoft has provided.
 * x-ms-original-file: specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/GrantListIncludeAllocatedBudget.json
 */
async function grantListIncludeAllocatedBudget() {
  const includeAllocatedBudget = true;
  const options = { includeAllocatedBudget };
  const credential = new DefaultAzureCredential();
  const client = new EducationManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.grants.listAll(options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Education/grants/default",
      "name": "default",
      "type": "Microsoft.Education/Grants",
      "properties": {
        "offerCap": {
          "currency": "USD",
          "value": 1000
        },
        "effectiveDate": "2021-11-09T09:08:05.505Z",
        "offerType": "Academic",
        "expirationDate": "2021-11-09T09:08:05.505Z",
        "status": "Active",
        "allocatedBudget": {
          "currency": "USD",
          "value": 0
        }
      }
    }
  ]
}

Definitions

Name	Description
Amount	The amount.
createdByType	The type of identity that created the resource.
ErrorResponse	Describes the format of Error response.
ErrorResponseBody	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Grant status	Grant status
Grant type	Grant Offer Type
GrantDetails	Grant details.
GrantListResponse	List of Grants info.
systemData	Metadata pertaining to creation and last modification of the resource.

Amount

Object

The amount.

Name	Type	Description
currency	string	The type of currency being used for the value.
value	number	Amount value.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Describes the format of Error response.

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

ErrorResponseBody

Object

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
error	ErrorResponse	The details of the error.

Grant status

Enumeration

Grant status

Value	Description
Active
Inactive

Grant type

Enumeration

Grant Offer Type

Value	Description
Student
Academic

GrantDetails

Object

Grant details.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.allocatedBudget	Amount	allocated budget
properties.effectiveDate	string (date-time)	Grant Effective Date
properties.expirationDate	string (date-time)	Expiration Date
properties.offerCap	Amount	Offer Cap
properties.offerType	Grant type	Grant Offer Type
properties.status	Grant status	Grant status
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

GrantListResponse

Object

List of Grants info.

Name	Type	Description
nextLink	string	The link (url) to the next page of results.
value	GrantDetails[]	The list of labs.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Grants - List All

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

GrantList

Sample request

Sample response

GrantListIncludeAllocatedBudget

Sample request

Sample response

Definitions

Amount

createdByType

ErrorResponse

ErrorResponseBody

Grant status

Grant type

GrantDetails

GrantListResponse

systemData