Microsoft Purview Account API

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Purview Account API
  description: APIs for managing Purview accounts, configurations, and administrative settings through Azure Resource Manager.
    Provides resource management operations for creating, updating, and deleting Purview accounts.
  tags:
  - Microsoft
  - Purview
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: microsoft-purview
    baseUri: https://management.azure.com
    description: Microsoft Purview Account API HTTP API.
    authentication:
      type: bearer
      token: '{{MICROSOFT_PURVIEW_TOKEN}}'
    resources:
    - name: subscriptions-subscriptionid-resourcegroups-reso
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}
      operations:
      - name: createorupdateaccount
        method: PUT
        description: Microsoft Purview Create or update a Purview account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getaccount
        method: GET
        description: Microsoft Purview Get a Purview account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateaccount
        method: PATCH
        description: Microsoft Purview Update a Purview account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteaccount
        method: DELETE
        description: Microsoft Purview Delete a Purview account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: subscriptions-subscriptionid-resourcegroups-reso
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts
      operations:
      - name: listaccountsbyresourcegroup
        method: GET
        description: Microsoft Purview List accounts by resource group
        inputParameters:
        - name: $skipToken
          in: query
          type: string
          description: The skip token for pagination
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: subscriptions-subscriptionid-providers-microsoft
      path: /subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts
      operations:
      - name: listaccountsbysubscription
        method: GET
        description: Microsoft Purview List accounts by subscription
        inputParameters:
        - name: $skipToken
          in: query
          type: string
          description: The skip token for pagination
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: subscriptions-subscriptionid-resourcegroups-reso
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listkeys
      operations:
      - name: listaccountkeys
        method: POST
        description: Microsoft Purview List account keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: subscriptions-subscriptionid-resourcegroups-reso
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/addRootCollectionAdmin
      operations:
      - name: addrootcollectionadmin
        method: POST
        description: Microsoft Purview Add root collection admin
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: subscriptions-subscriptionid-providers-microsoft
      path: /subscriptions/{subscriptionId}/providers/Microsoft.Purview/checkNameAvailability
      operations:
      - name: checknameavailability
        method: POST
        description: Microsoft Purview Check name availability
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: subscriptions-subscriptionid-resourcegroups-reso
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections
      operations:
      - name: listprivateendpointconnections
        method: GET
        description: Microsoft Purview List private endpoint connections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: subscriptions-subscriptionid-resourcegroups-reso
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
      operations:
      - name: getprivateendpointconnection
        method: GET
        description: Microsoft Purview Get a private endpoint connection
        inputParameters:
        - name: privateEndpointConnectionName
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: providers-microsoft-purview-operations
      path: /providers/Microsoft.Purview/operations
      operations:
      - name: listoperations
        method: GET
        description: Microsoft Purview List available operations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: microsoft-purview-rest
    description: REST adapter for Microsoft Purview Account API.
    resources:
    - path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}
      name: createorupdateaccount
      operations:
      - method: PUT
        name: createorupdateaccount
        description: Microsoft Purview Create or update a Purview account
        call: microsoft-purview.createorupdateaccount
        outputParameters:
        - type: object
          mapping: $.
    - path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}
      name: getaccount
      operations:
      - method: GET
        name: getaccount
        description: Microsoft Purview Get a Purview account
        call: microsoft-purview.getaccount
        outputParameters:
        - type: object
          mapping: $.
    - path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}
      name: updateaccount
      operations:
      - method: PATCH
        name: updateaccount
        description: Microsoft Purview Update a Purview account
        call: microsoft-purview.updateaccount
        outputParameters:
        - type: object
          mapping: $.
    - path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}
      name: deleteaccount
      operations:
      - method: DELETE
        name: deleteaccount
        description: Microsoft Purview Delete a Purview account
        call: microsoft-purview.deleteaccount
        outputParameters:
        - type: object
          mapping: $.
    - path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts
      name: listaccountsbyresourcegroup
      operations:
      - method: GET
        name: listaccountsbyresourcegroup
        description: Microsoft Purview List accounts by resource group
        call: microsoft-purview.listaccountsbyresourcegroup
        outputParameters:
        - type: object
          mapping: $.
    - path: /subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts
      name: listaccountsbysubscription
      operations:
      - method: GET
        name: listaccountsbysubscription
        description: Microsoft Purview List accounts by subscription
        call: microsoft-purview.listaccountsbysubscription
        outputParameters:
        - type: object
          mapping: $.
    - path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listkeys
      name: listaccountkeys
      operations:
      - method: POST
        name: listaccountkeys
        description: Microsoft Purview List account keys
        call: microsoft-purview.listaccountkeys
        outputParameters:
        - type: object
          mapping: $.
    - path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/addRootCollectionAdmin
      name: addrootcollectionadmin
      operations:
      - method: POST
        name: addrootcollectionadmin
        description: Microsoft Purview Add root collection admin
        call: microsoft-purview.addrootcollectionadmin
        outputParameters:
        - type: object
          mapping: $.
    - path: /subscriptions/{subscriptionId}/providers/Microsoft.Purview/checkNameAvailability
      name: checknameavailability
      operations:
      - method: POST
        name: checknameavailability
        description: Microsoft Purview Check name availability
        call: microsoft-purview.checknameavailability
        outputParameters:
        - type: object
          mapping: $.
    - path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections
      name: listprivateendpointconnections
      operations:
      - method: GET
        name: listprivateendpointconnections
        description: Microsoft Purview List private endpoint connections
        call: microsoft-purview.listprivateendpointconnections
        outputParameters:
        - type: object
          mapping: $.
    - path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
      name: getprivateendpointconnection
      operations:
      - method: GET
        name: getprivateendpointconnection
        description: Microsoft Purview Get a private endpoint connection
        call: microsoft-purview.getprivateendpointconnection
        with:
          privateEndpointConnectionName: rest.privateEndpointConnectionName
        outputParameters:
        - type: object
          mapping: $.
    - path: /providers/Microsoft.Purview/operations
      name: listoperations
      operations:
      - method: GET
        name: listoperations
        description: Microsoft Purview List available operations
        call: microsoft-purview.listoperations
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: microsoft-purview-mcp
    transport: http
    description: MCP adapter for Microsoft Purview Account API for AI agent use.
    tools:
    - name: createorupdateaccount
      description: Microsoft Purview Create or update a Purview account
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: microsoft-purview.createorupdateaccount
      outputParameters:
      - type: object
        mapping: $.
    - name: getaccount
      description: Microsoft Purview Get a Purview account
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: microsoft-purview.getaccount
      outputParameters:
      - type: object
        mapping: $.
    - name: updateaccount
      description: Microsoft Purview Update a Purview account
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: microsoft-purview.updateaccount
      outputParameters:
      - type: object
        mapping: $.
    - name: deleteaccount
      description: Microsoft Purview Delete a Purview account
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: microsoft-purview.deleteaccount
      outputParameters:
      - type: object
        mapping: $.
    - name: listaccountsbyresourcegroup
      description: Microsoft Purview List accounts by resource group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: microsoft-purview.listaccountsbyresourcegroup
      with:
        $skipToken: tools.$skipToken
      inputParameters:
      - name: $skipToken
        type: string
        description: The skip token for pagination
      outputParameters:
      - type: object
        mapping: $.
    - name: listaccountsbysubscription
      description: Microsoft Purview List accounts by subscription
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: microsoft-purview.listaccountsbysubscription
      with:
        $skipToken: tools.$skipToken
      inputParameters:
      - name: $skipToken
        type: string
        description: The skip token for pagination
      outputParameters:
      - type: object
        mapping: $.
    - name: listaccountkeys
      description: Microsoft Purview List account keys
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: microsoft-purview.listaccountkeys
      outputParameters:
      - type: object
        mapping: $.
    - name: addrootcollectionadmin
      description: Microsoft Purview Add root collection admin
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: microsoft-purview.addrootcollectionadmin
      outputParameters:
      - type: object
        mapping: $.
    - name: checknameavailability
      description: Microsoft Purview Check name availability
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: microsoft-purview.checknameavailability
      outputParameters:
      - type: object
        mapping: $.
    - name: listprivateendpointconnections
      description: Microsoft Purview List private endpoint connections
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: microsoft-purview.listprivateendpointconnections
      outputParameters:
      - type: object
        mapping: $.
    - name: getprivateendpointconnection
      description: Microsoft Purview Get a private endpoint connection
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: microsoft-purview.getprivateendpointconnection
      with:
        privateEndpointConnectionName: tools.privateEndpointConnectionName
      inputParameters:
      - name: privateEndpointConnectionName
        type: string
        description: privateEndpointConnectionName
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: listoperations
      description: Microsoft Purview List available operations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: microsoft-purview.listoperations
      outputParameters:
      - type: object
        mapping: $.
binds:
- namespace: env
  keys:
    MICROSOFT_PURVIEW_TOKEN: MICROSOFT_PURVIEW_TOKEN