swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SaaSOperations API
schemes:
- https
tags:
- name: SaaSOperations
paths:
  /providers/Microsoft.SaaS/operationResults/{operationId}:
    get:
      tags:
      - SaaSOperations
      operationId: microsoftAzureSaasoperationGet
      description: Gets information about the specified operation progress.
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/OperationIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Operation ended successfully. The request returns the updated SaaS resource.
          schema:
            $ref: '#/definitions/SaasResource'
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            Location:
              description: The URL to check the status of the asynchronous operation.
              type: string
            Retry-After:
              description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.
              format: int32
              type: integer
        default:
          description: A response indicating an error.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get operation status:
          $ref: ./examples/OperationResults/Get.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Get Providers Microsoft Saas Operationresults Operationid
definitions:
  Tags:
    type: object
    description: the resource tags.
    additionalProperties:
      type: string
  SaasResource:
    description: SaaS REST API resource definition.
    type: object
    x-ms-azure-resource: true
    properties:
      properties:
        description: saas properties
        type: object
        allOf:
        - $ref: '#/definitions/SaasProperties'
        - $ref: '#/definitions/SaasCreationProperties'
      name:
        type: string
        description: The name of the resource
        readOnly: true
      id:
        description: The resource uri
        type: string
        readOnly: true
      type:
        readOnly: true
        type: string
        description: Resource type.
      tags:
        description: the resource tags.
        $ref: '#/definitions/Tags'
  SaasCreationProperties:
    type: object
    description: properties for creation saas
    properties:
      offerId:
        type: string
        description: The offer id.
      publisherId:
        type: string
        description: The publisher id.
      quantity:
        type: number
        description: The seat count.
      skuId:
        type: string
        description: The plan id.
      paymentChannelType:
        type: string
        description: The Payment channel for the SaasSubscription.
        enum:
        - SubscriptionDelegated
        - CustomerDelegated
        x-ms-enum:
          name: paymentChannelType
          modelAsString: true
      paymentChannelMetadata:
        type: object
        description: The metadata about the SaaS subscription such as the AzureSubscriptionId and ResourceUri.
        additionalProperties:
          type: string
      saasResourceName:
        type: string
        description: The SaaS resource name.
      termId:
        type: string
        description: The current Term id.
      autoRenew:
        type: boolean
        description: Whether the SaaS subscription will auto renew upon term end.
      publisherTestEnvironment:
        type: string
        description: The environment in the publisher side for this resource.
      saasSubscriptionId:
        type: string
        description: The saas subscription id used for tenant to subscription level migration request.
      saasSessionId:
        type: string
        description: The saas session id used for dev service migration request.
  SaasProperties:
    type: object
    description: saas resource properties
    properties:
      status:
        type: string
        description: The SaaS Subscription Status.
        enum:
        - NotStarted
        - PendingFulfillmentStart
        - Subscribed
        - Unsubscribed
        - Suspended
        x-ms-enum:
          name: SaasResourceStatus
          modelAsString: true
      term:
        type: object
        description: The current Term object.
        properties:
          termUnit:
            type: string
            description: The unit indicating Monthly / Yearly
          startDate:
            type: string
            description: The start date of the current term
          endDate:
            type: string
            description: The end date of the current term
      isFreeTrial:
        type: boolean
        description: Whether the current term is a Free Trial term
      created:
        type: string
        description: The created date of this resource.
        readOnly: true
      lastModified:
        type: string
        description: The last modifier date if this resource.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to be used with the HTTP request.
  OperationIdParameter:
    name: operationId
    in: path
    required: true
    type: string
    description: the operation Id parameter.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'