swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ProfessionalServiceOperations API
schemes:
- https
tags:
- name: ProfessionalServiceOperations
paths:
  /providers/Microsoft.ProfessionalService/operationResults/{operationId}:
    get:
      tags:
      - ProfessionalServiceOperations
      operationId: microsoftAzureProfessionalserviceoperationGet
      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 ProfessionalService resource.
          schema:
            $ref: '#/definitions/ProfessionalServiceResource'
        '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/Operation/GetOperation.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Get Providers Microsoft Professionalservice Operationresults Operationid
definitions:
  Tags:
    type: object
    description: the resource tags.
    additionalProperties:
      type: string
  ProfessionalServiceProperties:
    type: object
    description: professionalService resource properties
    properties:
      status:
        type: string
        description: The ProfessionalService Subscription Status.
        enum:
        - NotStarted
        - PendingFulfillmentStart
        - Subscribed
        - Unsubscribed
        - Suspended
        x-ms-enum:
          name: ProfessionalServiceResourceStatus
          modelAsString: true
      term:
        type: object
        description: The current Term object.
        properties:
          termUnit:
            type: string
            description: The unit term eg P1M,P1Y,P2Y,P3Y meaning month,1year,2year,3year respectively
          startDate:
            type: string
            description: The start date of the current term
          endDate:
            type: string
            description: The end date of the current term
      billingPeriod:
        type: string
        description: The billing period eg P1M,P1Y for monthly,yearly respectively
      isFreeTrial:
        type: boolean
        description: Whether the current term is a Free Trial term
      paymentChannelType:
        type: string
        description: The Payment channel for the ProfessionalServiceSubscription.
        enum:
        - SubscriptionDelegated
        - CustomerDelegated
        x-ms-enum:
          name: paymentChannelType
          modelAsString: true
      paymentChannelMetadata:
        type: object
        description: The metadata about the ProfessionalService subscription such as the AzureSubscriptionId and ResourceUri.
        additionalProperties:
          type: string
      created:
        type: string
        description: The created date of this resource.
        readOnly: true
      lastModified:
        type: string
        description: The last modifier date if this resource.
  ProfessionalServiceResource:
    description: ProfessionalService REST API resource definition.
    type: object
    x-ms-azure-resource: true
    properties:
      properties:
        description: professionalService properties
        type: object
        allOf:
        - $ref: '#/definitions/ProfessionalServiceProperties'
        - $ref: '#/definitions/ProfessionalServiceCreationProperties'
      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'
  ProfessionalServiceCreationProperties:
    type: object
    description: properties for creation professionalService
    properties:
      offerId:
        type: string
        description: The offer id.
      publisherId:
        type: string
        description: The publisher id.
      skuId:
        type: string
        description: The plan id.
      autoRenew:
        type: boolean
        description: Whether the ProfessionalService subscription will auto renew upon term end.
      quoteId:
        type: string
        description: The quote id which the ProfessionalService will be purchase with.
      storeFront:
        type: string
        description: The store front which initiates the purchase.
      termUnit:
        type: string
        description: The unit term eg P1M,P1Y,P2Y,P3Y meaning month,1year,2year,3year respectively
      billingPeriod:
        type: string
        description: The billing period eg P1M,P1Y for monthly,yearly respectively
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    x-ms-parameter-location: client
    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'