Microsoft Azure Credential API

The Credential API from Microsoft Azure — 3 operation(s) for credential.

Documentation GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /credentials Create a Metrics Advisor data source credential · Microsoft Azure Create A New Data Source Credential #

Ask an LLM

“How do I store a new data source credential for Metrics Advisor?”

“What credential types can a Metrics Advisor data source credential use?”

Tell an agent

Create a Metrics Advisor {type} data source credential named {name}.

Add data source credential {name} of type {type} described as {desc}.

GET /credentials List Metrics Advisor data source credentials · Microsoft Azure List All Credentials #

Ask an LLM

“Which data source credentials are stored in my Metrics Advisor resource?”

“Can I page through Metrics Advisor credentials a few at a time?”

Tell an agent

List all Metrics Advisor data source credentials.

Show {size} Metrics Advisor data source credentials per page, skipping the first {skip}.

PATCH /credentials/{credentialId} Update a Metrics Advisor data source credential · Microsoft Azure Update A Data Source Credential #

Ask an LLM

“Can I rename or re-describe an existing Metrics Advisor data source credential?”

“How do I change a data source credential that already exists?”

Tell an agent

Rename Metrics Advisor data source credential {id} to {name}.

Update the description of {type} data source credential {id} to {desc}.

DELETE /credentials/{credentialId} Delete a Metrics Advisor data source credential · Microsoft Azure Delete A Data Source Credential #

Ask an LLM

“How do I delete a data source credential from Metrics Advisor?”

“Can I remove a Metrics Advisor credential by its ID?”

Tell an agent destructive · confirm first

Delete Metrics Advisor data source credential {id}.

Remove the data source credential with ID {id}.

GET /credentials/{credentialId} Get a Metrics Advisor data source credential · Microsoft Azure Get A Data Source Credential #

Ask an LLM

“What type and name does a given Metrics Advisor data source credential have?”

“Can I look up one data source credential by its ID?”

Tell an agent

Get Metrics Advisor data source credential {id}.

Show the details of data source credential ID {id}.

GET /credentials/{credentialName} Get a scanning credential by name · Microsoft Azure Get Credentials Credentialname #

Ask an LLM

“What is stored in a named credential used by Purview scanning?”

“Can I fetch a scan credential by its name rather than an ID?”

Tell an agent

Get scanning credential {name}.

Show the scanning credential named {name} using API version {v}.

PUT /credentials/{credentialName} Create or update a named scanning credential · Microsoft Azure Put Credentials Credentialname #

Ask an LLM

“How do I create a credential for Purview data source scans?”

“Which kind of credential can I register for scanning?”

Tell an agent

Create scanning credential {name} of kind {kind}.

Create or replace the named scanning credential {name}.

DELETE /credentials/{credentialName} Delete a named scanning credential · Microsoft Azure Delete Credentials Credentialname #

Ask an LLM

“How do I delete a scanning credential from my account?”

“Can I remove a scan credential by name?”

Tell an agent destructive · confirm first

Delete scanning credential {name}.

Remove the named scan credential {name} from the account.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure:microsoft-azure-credential-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Microsoft Azure Credential API
  version: '1.0'
  description: 'Operations tagged Credential across 2 of this provider''s published API definitions: metrics-advisor-openapi-original.yml, microsoftscanningclient-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://purview.azure.com/scan
tags:
- name: Credential
paths:
  /credentials:
    post:
      tags:
      - Credential
      summary: Microsoft Azure Create A New Data Source Credential
      operationId: microsoftAzureCreatecredential
      responses:
        '201':
          description: Success
          headers:
            Location:
              description: Location of the newly created resource.
              schema:
                type: string
        default:
          description: Client error or server error (4xx or 5xx)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCode'
      x-ms-examples:
        Create a new data source credential:
          $ref: ./examples/createCredential.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSourceCredential'
        description: Create data source credential request
        required: true
      security:
      - apim_key: []
        ma_api_key: []
    get:
      tags:
      - Credential
      summary: Microsoft Azure List All Credentials
      operationId: microsoftAzureListcredentials
      parameters:
      - in: query
        name: $skip
        description: for paging, skipped number
        schema:
          type: integer
          format: int32
      - in: query
        name: $maxpagesize
        description: the maximum number of items in one page
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceCredentialList'
        default:
          description: Client error or server error (4xx or 5xx)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCode'
      x-ms-pageable:
        nextLinkName: '@nextLink'
      x-ms-examples:
        List all credentials:
          $ref: ./examples/listCredentials.json
      description: Needs a more full description created.
      security:
      - apim_key: []
        ma_api_key: []
  /credentials/{credentialId}:
    patch:
      tags:
      - Credential
      summary: Microsoft Azure Update A Data Source Credential
      operationId: microsoftAzureUpdatecredential
      parameters:
      - in: path
        name: credentialId
        description: Data source credential unique ID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceCredential'
        default:
          description: Client error or server error (4xx or 5xx)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCode'
      x-ms-examples:
        Update a data source credential:
          $ref: ./examples/updateCredential.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/DataSourceCredentialPatch'
        description: Update data source credential request
        required: true
      security:
      - apim_key: []
        ma_api_key: []
    delete:
      tags:
      - Credential
      summary: Microsoft Azure Delete A Data Source Credential
      operationId: microsoftAzureDeletecredential
      parameters:
      - in: path
        name: credentialId
        description: Data source credential unique ID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: The resource is deleted successfully or does not exist.
        default:
          description: Client error or server error (4xx or 5xx)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCode'
      x-ms-examples:
        Delete a data source credential:
          $ref: ./examples/deleteCredential.json
      description: Needs a more full description created.
      security:
      - apim_key: []
        ma_api_key: []
    get:
      tags:
      - Credential
      summary: Microsoft Azure Get A Data Source Credential
      operationId: microsoftAzureGetcredential
      parameters:
      - in: path
        name: credentialId
        description: Data source credential unique ID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceCredential'
        default:
          description: Client error or server error (4xx or 5xx)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCode'
      x-ms-examples:
        Get a data source credential:
          $ref: ./examples/getCredential.json
      description: Needs a more full description created.
      security:
      - apim_key: []
        ma_api_key: []
  /credentials/{credentialName}:
    get:
      tags:
      - Credential
      description: Gets credential information
      operationId: microsoftAzureCredentialGet
      parameters:
      - in: path
        name: credentialName
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        default:
          description: An error response received from the Scanning Service
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
      x-ms-examples:
        Credential_Get:
          $ref: ./examples/Credential_Get.json
      summary: Microsoft Azure Get Credentials Credentialname
      security:
      - azure_auth:
        - user_impersonation
    put:
      tags:
      - Credential
      description: Creates an instance of a credential
      operationId: microsoftAzureCredentialCreateorupdate
      parameters:
      - in: path
        name: credentialName
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        default:
          description: An error response received from the Scanning Service
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
      x-ms-examples:
        Credential_CreateOrUpdate:
          $ref: ./examples/Credential_CreateOrUpdate.json
      summary: Microsoft Azure Put Credentials Credentialname
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Credential'
        required: true
      security:
      - azure_auth:
        - user_impersonation
    delete:
      tags:
      - Credential
      description: Deletes the credentials associated with the account
      operationId: microsoftAzureCredentialDelete
      parameters:
      - in: path
        name: credentialName
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        '204':
          description: Success
        default:
          description: An error response received from the Scanning Service
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
      x-ms-examples:
        Credential_Delete:
          $ref: ./examples/Credential_Delete.json
      summary: Microsoft Azure Delete Credentials Credentialname
      security:
      - azure_auth:
        - user_impersonation
    servers:
    - url: https://purview.azure.com/scan
components:
  schemas:
    DataSourceCredentialPatch:
      required:
      - dataSourceCredentialType
      type: object
      properties:
        dataSourceCredentialType:
          description: Type of data source credential
          enum:
          - AzureSQLConnectionString
          - DataLakeGen2SharedKey
          - ServicePrincipal
          - ServicePrincipalInKV
          type: string
          x-ms-enum:
            name: DataSourceCredentialType
            modelAsString: true
        dataSourceCredentialName:
          description: Name of data source credential
          type: string
        dataSourceCredentialDescription:
          description: Description of data source credential
          type: string
      discriminator:
        propertyName: dataSourceCredentialType
      example:
        dataSourceCredentialDescription: This is a data source credential
    ErrorCode:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
    DataSourceCredential:
      required:
      - dataSourceCredentialName
      - dataSourceCredentialType
      type: object
      properties:
        dataSourceCredentialType:
          description: Type of data source credential
          enum:
          - AzureSQLConnectionString
          - DataLakeGen2SharedKey
          - ServicePrincipal
          - ServicePrincipalInKV
          type: string
          x-ms-enum:
            name: DataSourceCredentialType
            modelAsString: true
        dataSourceCredentialId:
          format: uuid
          description: Unique id of data source credential
          type: string
          readOnly: true
        dataSourceCredentialName:
          description: Name of data source credential
          type: string
        dataSourceCredentialDescription:
          description: Description of data source credential
          type: string
      discriminator:
        propertyName: dataSourceCredentialType
      example:
        parameters:
          clientId: 88888888-8888-8888-8888-888888888888
          clientSecret: fake-client-secret
          tenantId: 12345678-1234-1234-1234-123456788888
        dataSourceCredentialName: A data source credential
        dataSourceCredentialDescription: This is a data source credential
        dataSourceCredentialType: ServicePrincipal
    DataSourceCredentialList:
      type: object
      properties:
        '@nextLink':
          type: string
          readOnly: true
        value:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/DataSourceCredential'
          readOnly: true
    ErrorModel:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorModel'
    Credential:
      required:
      - kind
      type: object
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
      properties:
        kind:
          enum:
          - AccountKey
          - ServicePrincipal
          - BasicAuth
          - SqlAuth
          - AmazonARN
          - ConsumerKeyAuth
          - DelegatedAuth
          - ManagedIdentity
          type: string
          x-ms-enum:
            name: CredentialType
            modelAsString: true
      discriminator:
        propertyName: kind
    ProxyResource:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
    ErrorResponseModel:
      type: object
      properties:
        error:
          allOf:
          - $ref: '#/components/schemas/ErrorModel'
    CredentialList:
      required:
      - value
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Credential'
        nextLink:
          type: string
        count:
          format: int64
          type: integer
  parameters:
    api-version:
      in: query
      name: api-version
      description: The api version to use.
      required: true
      x-ms-client-name: ApiVersion
      schema:
        type: string
  securitySchemes:
    ma_api_key:
      type: apiKey
      name: x-api-key
      in: header
    apim_key:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
    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.
x-refined-from:
- metrics-advisor-openapi-original.yml
- microsoftscanningclient-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'

Microsoft Azure Credential API

Operations 8

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification