swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Grants API
schemes:
- https
tags:
- name: Grants
paths:
  /providers/Microsoft.Education/grants:
    get:
      tags:
      - Grants
      x-ms-examples:
        GrantList:
          $ref: ./examples/GrantList.json
        GrantListIncludeAllocatedBudget:
          $ref: ./examples/GrantListIncludeAllocatedBudget.json
      operationId: microsoftAzureGrantsListall
      description: Get a list of grants that Microsoft has provided.
      parameters:
      - $ref: '#/parameters/IncludeAllocatedBudgetParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: list of Grants
          schema:
            $ref: '#/definitions/GrantListResponse'
        default:
          description: Describes the error if the operation is not successful.
          schema:
            $ref: '#/definitions/ErrorResponseBody'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Education Grants
  ? /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Education/grants
  : get:
      tags:
      - Grants
      x-ms-examples:
        GrantList:
          $ref: ./examples/GrantDefaultList.json
        GrantListIncludeAllocatedBudget:
          $ref: ./examples/GrantDefaultListIncludeAllocatedBudget.json
      operationId: microsoftAzureGrantsList
      description: Get details for a specific grant linked to the provided billing account and billing profile.
      parameters:
      - $ref: '#/parameters/BillingAccountNameParameter'
      - $ref: '#/parameters/BillingProfileNameParameter'
      - $ref: '#/parameters/IncludeAllocatedBudgetParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: list of Grants
          schema:
            $ref: '#/definitions/GrantListResponse'
        default:
          description: Describes the error if the operation is not successful.
          schema:
            $ref: '#/definitions/ErrorResponseBody'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Billing Billingaccounts Billingaccountname Billingprofiles Billingprofilename Providers Microsoft Education Grants
  ? /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Education/grants/default
  : get:
      tags:
      - Grants
      x-ms-examples:
        Grant:
          $ref: ./examples/Grant.json
        GrantIncludeAllocatedBudget:
          $ref: ./examples/GrantIncludeAllocatedBudget.json
      operationId: microsoftAzureGrantsGet
      description: Get details for a specific grant linked to the provided billing account and billing profile.
      parameters:
      - $ref: '#/parameters/BillingAccountNameParameter'
      - $ref: '#/parameters/BillingProfileNameParameter'
      - $ref: '#/parameters/IncludeAllocatedBudgetParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Grant detail
          schema:
            $ref: '#/definitions/GrantDetails'
        default:
          description: Describes the error if the operation is not successful.
          schema:
            $ref: '#/definitions/ErrorResponseBody'
      summary: Microsoft Azure Get Providers Microsoft Billing Billingaccounts Billingaccountname Billingprofiles Billingprofilename Providers Microsoft Education Grants Default
definitions:
  ErrorResponse:
    description: Describes the format of Error response.
    type: object
    properties:
      code:
        description: Error code
        type: string
      message:
        description: Error message indicating why the operation failed.
        type: string
  GrantDetails:
    description: Grant details.
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Resource
    properties:
      properties:
        $ref: '#/definitions/GrantDetailProperties'
        description: Grant detail properties.
        x-ms-client-flatten: true
  GrantListResponse:
    description: List of Grants info.
    type: object
    properties:
      value:
        description: The list of labs.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/GrantDetails'
      nextLink:
        description: The link (url) to the next page of results.
        type: string
        readOnly: true
  Amount:
    description: The amount.
    type: object
    properties:
      currency:
        description: The type of currency being used for the value.
        type: string
      value:
        description: Amount value.
        type: number
  ErrorResponseBody:
    description: Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
    type: object
    properties:
      error:
        description: The details of the error.
        $ref: '#/definitions/ErrorResponse'
  GrantDetailProperties:
    description: Grant detail properties
    type: object
    properties:
      offerCap:
        $ref: '#/definitions/Amount'
        description: Offer Cap
        readOnly: true
      effectiveDate:
        type: string
        format: date-time
        description: Grant Effective Date
        readOnly: true
      offerType:
        type: string
        description: Grant Offer Type
        enum:
        - Student
        - Academic
        x-ms-enum:
          name: Grant type
          modelAsString: true
        readOnly: true
      expirationDate:
        type: string
        format: date-time
        description: Expiration Date
        readOnly: true
      status:
        type: string
        description: Grant status
        enum:
        - Active
        - Inactive
        x-ms-enum:
          name: Grant status
          modelAsString: true
        readOnly: true
      allocatedBudget:
        $ref: '#/definitions/Amount'
        description: allocated budget
        readOnly: true
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Version of the API to be used with the client request. Current version is 2021-12-01-preview
  IncludeAllocatedBudgetParameter:
    name: includeAllocatedBudget
    x-ms-parameter-location: method
    in: query
    type: boolean
    description: May be used to include information about budget that has been allocated.
  BillingProfileNameParameter:
    name: billingProfileName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    description: The ID that uniquely identifies a billing profile.
  BillingAccountNameParameter:
    name: billingAccountName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    description: The ID that uniquely identifies a billing account.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'