Microsoft Azure Enterprise Knowledge Graph Service

swagger: '2.0'
info:
  title: Microsoft Azure Azure Enterprise Knowledge Graph Service
  description: >-
    Azure Enterprise Knowledge Graph Service is a platform for creating
    knowledge graphs at scale.
  version: '2018-12-03'
host: management.azure.com
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  azure_auth:
    type: oauth2
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    flow: implicit
    description: Azure Active Directory OAuth2 Flow
    scopes:
      user_impersonation: impersonate your user account
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EnterpriseKnowledgeGraph/services/{resourceName}
  : put:
      tags:
        - EnterpriseKnowledgeGraph
      description: >-
        Creates a EnterpriseKnowledgeGraph Service. EnterpriseKnowledgeGraph
        Service is a resource group wide resource type.
      operationId: microsoftAzureEnterpriseknowledgegraphCreate
      x-ms-examples:
        Create EnterpriseKnowledgeGraph:
          $ref: ./examples/CreateEnterpriseKnowledgeGraph.json
      parameters:
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/resourceNameParameter'
        - name: parameters
          in: body
          required: true
          schema:
            $ref: '#/definitions/EnterpriseKnowledgeGraph'
          description: The parameters to provide for the created EnterpriseKnowledgeGraph.
        - $ref: '#/parameters/apiVersionParameter'
        - $ref: '#/parameters/subscriptionIdParameter'
      responses:
        '200':
          description: >-
            The resource provider should return 200 (OK) to indicate that the
            operation completed successfully. 
          schema:
            $ref: '#/definitions/EnterpriseKnowledgeGraph'
        '201':
          description: >-
            If resource is created successfully, the service should return 201
            (Creating). Execution to continue asynchronously.
          schema:
            $ref: '#/definitions/EnterpriseKnowledgeGraph'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      summary: >-
        Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Enterpriseknowledgegraph Services Resourcename
    patch:
      tags:
        - EnterpriseKnowledgeGraph
      description: Updates a EnterpriseKnowledgeGraph Service
      operationId: microsoftAzureEnterpriseknowledgegraphUpdate
      x-ms-examples:
        Update EnterpriseKnowledgeGraph:
          $ref: ./examples/UpdateEnterpriseKnowledgeGraph.json
      parameters:
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/resourceNameParameter'
        - name: parameters
          in: body
          required: true
          x-ms-client-flatten: true
          schema:
            $ref: '#/definitions/EnterpriseKnowledgeGraph'
          description: The parameters to provide for the created EnterpriseKnowledgeGraph.
        - $ref: '#/parameters/apiVersionParameter'
        - $ref: '#/parameters/subscriptionIdParameter'
      responses:
        '200':
          description: >-
            The resource provider should return 200 (OK) to indicate that the
            operation completed successfully. 
          schema:
            $ref: '#/definitions/EnterpriseKnowledgeGraph'
        '201':
          description: >-
            If resource is updated successfully, the service should return 201
            (Created). Execution to continue asynchronously.
          schema:
            $ref: '#/definitions/EnterpriseKnowledgeGraph'
        default:
          description: >-
            Error response describing why the operation failed. If the resource
            group *or* resource does not exist, 404 (NotFound) should be
            returned.
          schema:
            $ref: '#/definitions/Error'
      summary: >-
        Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Enterpriseknowledgegraph Services Resourcename
    delete:
      tags:
        - EnterpriseKnowledgeGraph
      description: 'Deletes a EnterpriseKnowledgeGraph Service from the resource group. '
      operationId: microsoftAzureEnterpriseknowledgegraphDelete
      x-ms-examples:
        Delete EnterpriseKnowledgeGraph:
          $ref: ./examples/DeleteEnterpriseKnowledgeGraph.json
      parameters:
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/resourceNameParameter'
        - $ref: '#/parameters/apiVersionParameter'
        - $ref: '#/parameters/subscriptionIdParameter'
      responses:
        '200':
          description: >-
            A 200 (OK) should be returned if the object exists and was deleted
            successfully;
        '204':
          description: >-
            a 204 (NoContent) should be used if the resource does not exist and
            the request is well formed.
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      summary: >-
        Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Enterpriseknowledgegraph Services Resourcename
    get:
      tags:
        - EnterpriseKnowledgeGraph
      description: Returns a EnterpriseKnowledgeGraph service specified by the parameters.
      operationId: microsoftAzureEnterpriseknowledgegraphGet
      x-ms-examples:
        Get EnterpriseKnowledgeGraph:
          $ref: ./examples/GetEnterpriseKnowledgeGraph.json
      parameters:
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/resourceNameParameter'
        - $ref: '#/parameters/apiVersionParameter'
        - $ref: '#/parameters/subscriptionIdParameter'
      responses:
        '200':
          description: >-
            The resource provider should return 200 (OK) to indicate that the
            operation completed successfully. 
          schema:
            $ref: '#/definitions/EnterpriseKnowledgeGraph'
        default:
          description: >-
            Error response describing why the operation failed. If the resource
            group *or* resource does not exist, 404 (NotFound) should be
            returned.
          schema:
            $ref: '#/definitions/Error'
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Enterpriseknowledgegraph Services Resourcename
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EnterpriseKnowledgeGraph/services:
    get:
      tags:
        - EnterpriseKnowledgeGraph
      description: >-
        Returns all the resources of a particular type belonging to a resource
        group
      operationId: microsoftAzureEnterpriseknowledgegraphListbyresourcegroup
      x-ms-examples:
        List EnterpriseKnowledgeGraph by Resource Group:
          $ref: ./examples/ListEnterpriseKnowledgeGraphByResourceGroup.json
      parameters:
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/subscriptionIdParameter'
        - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: >-
            The resource provider should return 200 (OK) to indicate that the
            operation completed successfully. For other errors (e.g. internal
            errors) use the appropriate HTTP error code.

            The nextLink field is expected to point to the URL the client should
            use to fetch the next page (per server side paging). This matches
            the OData guidelines for paged responses here. If a resource
            provider does not support paging, it should return the same body
            (JSON object with “value” property) but omit nextLink entirely (or
            set to null, *not* empty string) for future compatibility.

            The nextLink should be implemented using following query parameters:

            · skipToken: opaque token that allows the resource provider to skip
            resources already enumerated. This value is defined and returned by
            the RP after first request via nextLink.

            · top: the optional client query parameter which defines the maximum
            number of records to be returned by the server.

            Implementation details:

            · NextLink may include all the query parameters (specifically OData
            $filter) used by the client in the first query. 

            · Server may return less records than requested with nextLink.
            Returning zero records with NextLink is an acceptable response. 

            Clients must fetch records until the nextLink is not returned back /
            null. Clients should never rely on number of returned records to
            determinate if pagination is completed.
          schema:
            $ref: '#/definitions/EnterpriseKnowledgeGraphResponseList'
        default:
          description: >-
            Error response describing why the operation failed. If the resource
            group does not exist, 404 (NotFound) will be returned.
          schema:
            $ref: '#/definitions/Error'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Enterpriseknowledgegraph Services
  /subscriptions/{subscriptionId}/providers/Microsoft.EnterpriseKnowledgeGraph/services:
    get:
      tags:
        - EnterpriseKnowledgeGraph
      description: >-
        Returns all the resources of a particular type belonging to a
        subscription.
      operationId: microsoftAzureEnterpriseknowledgegraphList
      x-ms-examples:
        List EnterpriseKnowledgeGraph by Subscription:
          $ref: ./examples/ListEnterpriseKnowledgeGraphBySubscription.json
      parameters:
        - $ref: '#/parameters/apiVersionParameter'
        - $ref: '#/parameters/subscriptionIdParameter'
      responses:
        '200':
          description: >-
            The resource provider should return 200 (OK) to indicate that the
            operation completed successfully. For other errors (e.g. internal
            errors) use the appropriate HTTP error code.

            The nextLink field is expected to point to the URL the client should
            use to fetch the next page (per server side paging). This matches
            the OData guidelines for paged responses. If a resource provider
            does not support paging, it should return the same body but leave
            nextLink empty for future compatibility.

            For a detailed explanation of each field in the response body,
            please refer to the request body description in the PUT resource
            section. 
          schema:
            $ref: '#/definitions/EnterpriseKnowledgeGraphResponseList'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Enterpriseknowledgegraph Services
  /providers/Microsoft.EnterpriseKnowledgeGraph/operations:
    get:
      tags:
        - Operations
      description: Lists all the available EnterpriseKnowledgeGraph services operations.
      operationId: microsoftAzureOperationsList
      x-ms-examples:
        Get Operations:
          $ref: ./examples/GetOperations.json
      parameters:
        - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/definitions/OperationEntityListResult'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Enterpriseknowledgegraph Operations
definitions:
  Resource:
    description: Azure resource
    x-ms-azure-resource: true
    properties:
      id:
        description: Specifies the resource ID.
        type: string
        readOnly: true
      name:
        description: Specifies the name of the resource.
        type: string
        readOnly: true
      type:
        description: Specifies the type of the resource.
        type: string
        readOnly: true
      location:
        description: Specifies the location of the resource.
        type: string
      tags:
        description: Contains resource tags defined as key/value pairs.
        type: object
        additionalProperties:
          type: string
      sku:
        $ref: '#/definitions/Sku'
        description: Gets or sets the SKU of the resource.
  Sku:
    properties:
      name:
        $ref: '#/definitions/SkuName'
        description: The sku name
    required:
      - name
    description: The SKU of the EnterpriseKnowledgeGraph service account.
  SkuName:
    type: string
    description: The name of SKU.
    enum:
      - F0
      - S1
    x-ms-enum:
      name: SkuName
      modelAsString: true
  EnterpriseKnowledgeGraph:
    description: EnterpriseKnowledgeGraph resource definition
    allOf:
      - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/EnterpriseKnowledgeGraphProperties'
        description: The set of properties specific to EnterpriseKnowledgeGraph resource
  EnterpriseKnowledgeGraphProperties:
    properties:
      description:
        type: string
        description: The description of the EnterpriseKnowledgeGraph
      metadata:
        description: Specifies the metadata  of the resource.
        type: object
      provisioningState:
        type: string
        description: The state of EnterpriseKnowledgeGraph provisioning
        enum:
          - Creating
          - Deleting
          - Failed
          - Succeeded
    description: The parameters to provide for the EnterpriseKnowledgeGraph.
  EnterpriseKnowledgeGraphResponseList:
    properties:
      nextLink:
        description: >-
          The link used to get the next page of EnterpriseKnowledgeGraph service
          resources.
        type: string
      value:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/EnterpriseKnowledgeGraph'
        description: >-
          Gets the list of EnterpriseKnowledgeGraph service results and their
          properties.
    description: The list of  EnterpriseKnowledgeGraph service operation response.
  Error:
    properties:
      error:
        $ref: '#/definitions/ErrorBody'
        description: The error body.
    description: EnterpriseKnowledgeGraph Service error object.
  ErrorBody:
    properties:
      code:
        type: string
        description: error code
      message:
        type: string
        description: error message
    description: EnterpriseKnowledgeGraph Service error body.
    required:
      - code
      - message
  OperationEntityListResult:
    description: The list of EnterpriseKnowledgeGraph service operation response.
    type: object
    properties:
      nextLink:
        description: The link used to get the next page of operations.
        type: string
      value:
        description: The list of operations.
        type: array
        items:
          $ref: '#/definitions/OperationEntity'
  OperationEntity:
    description: The operations supported by EnterpriseKnowledgeGraph Service Management.
    type: object
    properties:
      name:
        description: 'Operation name: {provider}/{resource}/{operation}.'
        type: string
      display:
        $ref: '#/definitions/OperationDisplayInfo'
        description: >-
          The operation supported by EnterpriseKnowledgeGraph Service
          Management.
      origin:
        description: The origin of the operation.
        type: string
      properties:
        description: Additional properties.
        type: object
  OperationDisplayInfo:
    description: The operation supported by EnterpriseKnowledgeGraph Service Management.
    type: object
    properties:
      description:
        description: The description of the operation.
        type: string
      operation:
        description: The action that users can perform, based on their permission level.
        type: string
      provider:
        description: 'Service provider: Microsoft EnterpriseKnowledgeGraph Service.'
        type: string
      resource:
        description: Resource on which the operation is performed.
        type: string
parameters:
  resourceGroupNameParameter:
    name: resourceGroupName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    maxLength: 64
    minLength: 2
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
    description: >-
      The name of the EnterpriseKnowledgeGraph resource group in the user
      subscription.
  resourceNameParameter:
    name: resourceName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    maxLength: 64
    minLength: 2
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
    description: The name of the EnterpriseKnowledgeGraph resource.
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Azure Subscription ID.
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Version of the API to be used with the client request.
tags:
  - name: EnterpriseKnowledgeGraph
  - name: Operations