Azure Synapse Analytics - Keys API — Keys

naftiko: 1.0.0-alpha2
info:
  label: Azure Synapse Analytics - Keys API — Keys
  description: 'Azure Synapse Analytics - Keys API — Keys. 4 operations. Lead operation: Azure Synapse Analytics List workspace
    keys. Self-contained Naftiko capability covering one Microsoft Azure Synapse Analytics business surface.'
  tags:
  - Microsoft Azure Synapse Analytics
  - Keys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_SYNAPSE_ANALYTICS_API_KEY: MICROSOFT_AZURE_SYNAPSE_ANALYTICS_API_KEY
capability:
  consumes:
  - type: http
    namespace: azure-synapse-analytics-keys-keys
    baseUri: https://management.azure.com
    description: Azure Synapse Analytics - Keys API — Keys business capability. Self-contained, no shared references.
    resources:
    - name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys
      operations:
      - name: keyslistbyworkspace
        method: GET
        description: Azure Synapse Analytics List workspace keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName}
      operations:
      - name: keysget
        method: GET
        description: Azure Synapse Analytics Get a workspace key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyName
          in: path
          type: string
          description: The name of the workspace key.
          required: true
      - name: keyscreateorupdate
        method: PUT
        description: Azure Synapse Analytics Create or update a workspace key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyName
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: keysdelete
        method: DELETE
        description: Azure Synapse Analytics Delete a workspace key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyName
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.MICROSOFT_AZURE_SYNAPSE_ANALYTICS_API_KEY}}'
  exposes:
  - type: rest
    namespace: azure-synapse-analytics-keys-keys-rest
    port: 8080
    description: REST adapter for Azure Synapse Analytics - Keys API — Keys. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-synapse/workspaces/{workspacename}/keys
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: GET
        name: keyslistbyworkspace
        description: Azure Synapse Analytics List workspace keys
        call: azure-synapse-analytics-keys-keys.keyslistbyworkspace
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-synapse/workspaces/{workspacename}/keys/{keyname}
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: GET
        name: keysget
        description: Azure Synapse Analytics Get a workspace key
        call: azure-synapse-analytics-keys-keys.keysget
        with:
          keyName: rest.keyName
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: keyscreateorupdate
        description: Azure Synapse Analytics Create or update a workspace key
        call: azure-synapse-analytics-keys-keys.keyscreateorupdate
        with:
          keyName: rest.keyName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: keysdelete
        description: Azure Synapse Analytics Delete a workspace key
        call: azure-synapse-analytics-keys-keys.keysdelete
        with:
          keyName: rest.keyName
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: azure-synapse-analytics-keys-keys-mcp
    port: 9090
    transport: http
    description: MCP adapter for Azure Synapse Analytics - Keys API — Keys. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: azure-synapse-analytics-list-workspace
      description: Azure Synapse Analytics List workspace keys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-synapse-analytics-keys-keys.keyslistbyworkspace
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-get-workspace
      description: Azure Synapse Analytics Get a workspace key
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-synapse-analytics-keys-keys.keysget
      with:
        keyName: tools.keyName
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-create-update
      description: Azure Synapse Analytics Create or update a workspace key
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: azure-synapse-analytics-keys-keys.keyscreateorupdate
      with:
        keyName: tools.keyName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-delete-workspace
      description: Azure Synapse Analytics Delete a workspace key
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: azure-synapse-analytics-keys-keys.keysdelete
      with:
        keyName: tools.keyName
      outputParameters:
      - type: object
        mapping: $.