Microsoft Azure SubscriptionDefinitions API

openapi: 3.2.0
info:
  version: 2017-11-01-preview
  title: Microsoft Azure SubscriptionDefinitionsClient Subscription…
  description: Subscription definitions client provides an interface to create, modify and retrieve azure subscriptions programmatically.
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: SubscriptionDefinitions
paths:
  /providers/Microsoft.Subscription/operations:
    get:
      tags:
      - SubscriptionDefinitions
      description: Lists all of the available Microsoft.Subscription API operations.
      operationId: microsoftAzureSubscriptiondefinitionsoperationmetadataList
      x-ms-examples:
        getSubscriptionDefinitionOperations:
          $ref: ./examples/getOperations.json
      parameters:
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Subscription Operations
  /providers/Microsoft.Subscription/subscriptionDefinitions/{subscriptionDefinitionName}:
    put:
      tags:
      - SubscriptionDefinitions
      description: Create an Azure subscription definition.
      operationId: microsoftAzureSubscriptiondefinitionsCreate
      x-ms-examples:
        createSubscriptionDefinition:
          $ref: ./examples/createSubscriptionDefinition.json
      parameters:
      - name: subscriptionDefinitionName
        in: path
        description: The name of the Azure subscription definition.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Normal response for a successful query. The response body will contain the data that matches the filters specified in the query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionDefinition'
        '202':
          description: Accepted. Subscription creation is in progress.
          headers:
            Location:
              description: GET this URL to retrieve the status of the asynchronous operation.
              schema:
                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.
              schema:
                type: string
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Providers Microsoft Subscription Subscriptiondefinitions…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionDefinition'
        description: The subscription definition creation.
        required: true
    get:
      tags:
      - SubscriptionDefinitions
      description: Get an Azure subscription definition.
      operationId: microsoftAzureSubscriptiondefinitionsGet
      x-ms-examples:
        getSubscriptionDefinition:
          $ref: ./examples/getSubscriptionDefinition.json
      parameters:
      - name: subscriptionDefinitionName
        in: path
        description: The name of the Azure subscription definition.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Normal response for a successful query. The response body will contain the data that matches the filters specified in the query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionDefinition'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Get Providers Microsoft Subscription Subscriptiondefinitions…
  /providers/Microsoft.Subscription/subscriptionDefinitions:
    get:
      tags:
      - SubscriptionDefinitions
      description: List an Azure subscription definition by subscriptionId.
      operationId: microsoftAzureSubscriptiondefinitionsList
      x-ms-examples:
        ListSubscriptionDefinition:
          $ref: ./examples/listSubscriptionDefinitions.json
      parameters:
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Normal response for a successful query. The response body will contain the data that matches the filters specified in the query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionDefinitionList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Subscription Subscriptiondefinitions
  /providers/Microsoft.Subscription/subscriptionOperations/{operationId}:
    get:
      tags:
      - SubscriptionDefinitions
      description: Retrieves the status of the subscription definition PUT operation. The URI of this API is returned in the Location field of the response header.
      operationId: microsoftAzureSubscriptiondefinitionsGetoperationstatus
      x-ms-examples:
        getSubscriptionDefinitionOperation:
          $ref: ./examples/getSubscriptionDefinitionOperation.json
      parameters:
      - $ref: '#/components/parameters/apiVersionParameter'
      - name: operationId
        in: path
        description: The operation ID, which can be found from the Location field in the generate recommendation response header.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful completion of the asynchronous operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionDefinition'
        '202':
          description: Accepted. Subscription update is in progress.
          headers:
            Location:
              description: The URL where the status of the asynchronous operation can be checked.
              schema:
                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.
              schema:
                type: string
      deprecated: false
      summary: Microsoft Azure Get Providers Microsoft Subscription Subscriptionoperations…
components:
  schemas:
    SubscriptionDefinition:
      description: The subscription definition used to create the subscription.
      x-ms-azure-resource: true
      properties:
        id:
          description: The resource ID.
          type: string
          readOnly: true
        name:
          description: The name of the resource.
          type: string
          readOnly: true
        type:
          description: The type of the resource.
          type: string
          readOnly: true
        properties:
          description: the subscription definition properties
          x-ms-client-flatten: true
          $ref: '#/components/schemas/SubscriptionDefinitionProperties'
    SubscriptionDefinitionList:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionDefinition'
          description: An array of subscriptionDefinitions
        nextLink:
          type: string
          description: URL to get the next set of operation list results if there are any.
      description: Subscription Definition List operation response.
    SubscriptionDefinitionProperties:
      description: The subscription definition properties.
      properties:
        subscriptionId:
          description: The ID of the subscription.
          readOnly: true
          type: string
        subscriptionDisplayName:
          description: The display name of the subscription.
          type: string
        offerType:
          type: string
          description: The offer type of the subscription. For example, MS-AZR-0017P (EnterpriseAgreement) and MS-AZR-0148P (EnterpriseAgreement devTest) are available.
          x-ms-mutability:
          - create
          - read
        etag:
          description: The etag the subscription definition.
          type: string
    Operation:
      description: REST API operation
      type: object
      properties:
        name:
          description: 'Operation name: {provider}/{resource}/{operation}'
          type: string
        display:
          description: The object that represents the operation.
          properties:
            provider:
              description: 'Service provider: Microsoft.Subscription'
              type: string
            resource:
              description: 'Resource on which the operation is performed: Profile, endpoint, etc.'
              type: string
            operation:
              description: 'Operation type: Read, write, delete, etc.'
              type: string
    OperationListResult:
      description: Result of the request to list operations. It contains a list of operations and a URL link to get the next set of results.
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
          description: List of operations.
        nextLink:
          type: string
          description: URL to get the next set of operation list results if there are any.
    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
  parameters:
    apiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Version of the API to be used with the client request. Current version is 2015-06-01
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow