Azure Container Registry Runs API

The Runs API from Azure Container Registry — 4 operation(s) for runs.

GitHub OpenAPI

Operations 5

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs Runs list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId} Runs get #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId} Runs update #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}/listLogSasUrl Runs get log sas url #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}/cancel Runs cancel #

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/azure-container-registry:azure-container-registry-runs-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.

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

OpenAPI Specification

azure-container-registry-runs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: '2019-04-01'
  title: ContainerRegistryManagementClient Runs API
servers:
- url: https://management.azure.com/
security:
- azure_auth:
  - user_impersonation
tags:
- name: Runs
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs
  : get:
      tags:
      - Runs
      description: Gets all the runs for a registry.
      operationId: Runs_List
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/RegistryNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: $filter
        in: query
        description: The runs filter to apply on the operation. Arithmetic operators are not supported. The allowed string function is 'contains'. All logical operators except 'Not', 'Has', 'All' are allowed.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: $top is supported for get list of runs, which limits the maximum number of runs to return.
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunListResult'
        default:
          description: Error response describing why the operation failed.
      x-ms-odata: '#/definitions/RunFilter'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Runs list
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}
  : get:
      tags:
      - Runs
      description: Gets the detailed information for a given run.
      operationId: Runs_Get
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/RegistryNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: runId
        in: path
        description: The run ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Run'
        default:
          description: Error response describing why the operation failed. If the registry/run doesn't exist, 404 (Not found) is returned.
      summary: Runs get
      x-summary-source: derived
    patch:
      tags:
      - Runs
      description: Patch the run properties.
      operationId: Runs_Update
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/RegistryNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: runId
        in: path
        description: The run ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Run'
        '201':
          description: The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Run'
        default:
          description: Error response describing why the operation failed. If the registry/build doesn't exist, 404 (Not found) is returned. If any of the input parameters is wrong, 400(Bad Request) is returned.
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunUpdateParameters'
        description: The run update properties.
        required: true
      summary: Runs update
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}/listLogSasUrl
  : post:
      tags:
      - Runs
      description: Gets a link to download the run logs.
      operationId: Runs_GetLogSasUrl
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/RegistryNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: runId
        in: path
        description: The run ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunGetLogResult'
        default:
          description: Error response describing why the operation failed. If the registry/run doesn't exist, 404 (Not found) is returned.
      summary: Runs get log sas url
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}/cancel
  : post:
      tags:
      - Runs
      description: Cancel an existing run.
      operationId: Runs_Cancel
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/RegistryNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: runId
        in: path
        description: The run ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
        '202':
          description: The request was successfully accepted; the operation will complete asynchronously.
        default:
          description: Error response describing why the operation failed. If the registry/run doesn't exist, 404 (Not found) is returned.
      x-ms-long-running-operation: true
      summary: Runs cancel
      x-summary-source: derived
components:
  schemas:
    RunListResult:
      description: Collection of runs.
      type: object
      properties:
        value:
          description: The collection value.
          type: array
          items:
            $ref: '#/components/schemas/Run'
        nextLink:
          description: The URI that can be used to request the next set of paged results.
          type: string
    AgentProperties:
      description: The properties that determine the run agent configuration.
      type: object
      properties:
        cpu:
          format: int32
          description: The CPU configuration in terms of number of cores required for the run.
          type: integer
    ImageDescriptor:
      description: Properties for a registry image.
      type: object
      properties:
        registry:
          description: The registry login server.
          type: string
        repository:
          description: The repository name.
          type: string
        tag:
          description: The tag name.
          type: string
        digest:
          description: The sha256-based digest of the image manifest.
          type: string
    RunGetLogResult:
      description: The result of get log link operation.
      type: object
      properties:
        logLink:
          description: The link to logs for a run on a azure container registry.
          type: string
    TimerTriggerDescriptor:
      type: object
      properties:
        timerTriggerName:
          description: The timer trigger name that caused the run.
          type: string
        scheduleOccurrence:
          description: The occurrence that triggered the run.
          type: string
    SourceTriggerDescriptor:
      description: The source trigger that caused a run.
      type: object
      properties:
        id:
          description: The unique ID of the trigger.
          type: string
        eventType:
          description: The event type of the trigger.
          type: string
        commitId:
          description: The unique ID that identifies a commit.
          type: string
        pullRequestId:
          description: The unique ID that identifies pull request.
          type: string
        repositoryUrl:
          description: The repository URL.
          type: string
        branchName:
          description: The branch name in the repository.
          type: string
        providerType:
          description: The source control provider type.
          type: string
    ProxyResource:
      description: The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.
      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
      x-ms-azure-resource: true
    RunProperties:
      description: The properties for a run.
      type: object
      properties:
        runId:
          description: The unique identifier for the run.
          type: string
        status:
          description: The current status of the run.
          enum:
          - Queued
          - Started
          - Running
          - Succeeded
          - Failed
          - Canceled
          - Error
          - Timeout
          type: string
          x-ms-enum:
            name: RunStatus
            modelAsString: true
        lastUpdatedTime:
          format: date-time
          description: The last updated time for the run.
          type: string
        runType:
          description: The type of run.
          enum:
          - QuickBuild
          - QuickRun
          - AutoBuild
          - AutoRun
          type: string
          x-ms-enum:
            name: RunType
            modelAsString: true
        createTime:
          format: date-time
          description: The time the run was scheduled.
          type: string
        startTime:
          format: date-time
          description: The time the run started.
          type: string
        finishTime:
          format: date-time
          description: The time the run finished.
          type: string
        outputImages:
          description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies.
          type: array
          items:
            $ref: '#/components/schemas/ImageDescriptor'
        task:
          description: The task against which run was scheduled.
          type: string
        imageUpdateTrigger:
          $ref: '#/components/schemas/ImageUpdateTrigger'
          description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured.
        sourceTrigger:
          $ref: '#/components/schemas/SourceTriggerDescriptor'
          description: The source trigger that caused the run.
        platform:
          $ref: '#/components/schemas/PlatformProperties'
          description: The platform properties against which the run will happen.
        agentConfiguration:
          $ref: '#/components/schemas/AgentProperties'
          description: The machine configuration of the run agent.
        sourceRegistryAuth:
          description: The scope of the credentials that were used to login to the source registry during this run.
          type: string
        customRegistries:
          description: The list of custom registries that were logged in during this run.
          type: array
          items:
            type: string
        runErrorMessage:
          description: The error message received from backend systems after the run is scheduled.
          type: string
          readOnly: true
        provisioningState:
          description: The provisioning state of a run.
          enum:
          - Creating
          - Updating
          - Deleting
          - Succeeded
          - Failed
          - Canceled
          type: string
          x-ms-enum:
            name: ProvisioningState
            modelAsString: true
        isArchiveEnabled:
          description: The value that indicates whether archiving is enabled or not.
          default: false
          type: boolean
        timerTrigger:
          $ref: '#/components/schemas/TimerTriggerDescriptor'
          description: The timer trigger that caused the run.
    PlatformProperties:
      description: The platform properties against which the run has to happen.
      required:
      - os
      type: object
      properties:
        os:
          description: The operating system type required for the run.
          enum:
          - Windows
          - Linux
          type: string
          x-ms-enum:
            name: OS
            modelAsString: true
        architecture:
          description: The OS architecture.
          enum:
          - amd64
          - x86
          - arm
          type: string
          x-ms-enum:
            name: Architecture
            modelAsString: true
        variant:
          description: Variant of the CPU.
          enum:
          - v6
          - v7
          - v8
          type: string
          x-ms-enum:
            name: Variant
            modelAsString: true
    ImageUpdateTrigger:
      description: The image update trigger that caused a build.
      type: object
      properties:
        id:
          description: The unique ID of the trigger.
          type: string
        timestamp:
          format: date-time
          description: The timestamp when the image update happened.
          type: string
        images:
          description: The list of image updates that caused the build.
          type: array
          items:
            $ref: '#/components/schemas/ImageDescriptor'
    Run:
      description: Run resource properties
      type: object
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
      properties:
        properties:
          $ref: '#/components/schemas/RunProperties'
          description: The properties of a run.
          x-ms-client-flatten: true
    RunUpdateParameters:
      description: The set of run properties that can be updated.
      type: object
      properties:
        isArchiveEnabled:
          description: The value that indicates whether archiving is enabled or not.
          type: boolean
  parameters:
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group to which the container registry belongs.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The Microsoft Azure subscription ID.
      required: true
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      description: The client API version.
      required: true
      schema:
        type: string
    RegistryNameParameter:
      name: registryName
      in: path
      description: The name of the container registry.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 50
        minLength: 5
        pattern: ^[a-zA-Z0-9]*$
  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