Microsoft Azure Containers API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Containers API
  description: Operations on blob containers
schemes:
- https
tags:
- name: Containers
  description: Operations on blob containers
paths:
  /{containerName}:
    put:
      operationId: Container_Create
      summary: Microsoft Azure Create a Container
      description: Creates a new container under the specified account. If the container with the same name already exists, the operation fails.
      tags:
      - Containers
      parameters:
      - $ref: '#/components/parameters/ContainerNameParameter'
      - name: restype
        in: query
        required: true
        schema:
          type: string
          enum:
          - container
        example: container
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: x-ms-blob-public-access
        in: header
        description: Specifies whether data in the container may be accessed publicly.
        schema:
          type: string
          enum:
          - container
          - blob
        example: container
      - name: x-ms-meta
        in: header
        description: Name-value pairs to associate with the container as metadata.
        schema:
          type: string
        example: example_value
      responses:
        '201':
          description: Successfully created the container.
          headers:
            ETag:
              schema:
                type: string
              description: The ETag for the container.
            Last-Modified:
              schema:
                type: string
                format: date-time-rfc1123
              description: The date/time that the container was last modified.
        '409':
          description: The container already exists.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
              examples:
                ContainerCreate409Example:
                  summary: Default Container_Create 409 response
                  x-microcks-default: true
                  value:
                    Code: example_value
                    Message: example_value
                    AuthenticationErrorDetail: example_value
        default:
          description: An error occurred.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
              examples:
                ContainerCreatedefaultExample:
                  summary: Default Container_Create default response
                  x-microcks-default: true
                  value:
                    Code: example_value
                    Message: example_value
                    AuthenticationErrorDetail: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: Container_ListBlobs
      summary: Microsoft Azure List Blobs in a Container
      description: Returns a list of the blobs under the specified container.
      tags:
      - Containers
      parameters:
      - $ref: '#/components/parameters/ContainerNameParameter'
      - name: restype
        in: query
        required: true
        schema:
          type: string
          enum:
          - container
        example: container
      - name: comp
        in: query
        required: true
        schema:
          type: string
          enum:
          - list
        example: list
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: prefix
        in: query
        description: Filters the results to return only blobs whose name begins with the specified prefix.
        schema:
          type: string
        example: example_value
      - name: delimiter
        in: query
        description: Filters the results to return only blobs with names up to the specified delimiter.
        schema:
          type: string
        example: example_value
      - name: marker
        in: query
        description: A string value that identifies the portion of the list to be returned.
        schema:
          type: string
        example: example_value
      - name: maxresults
        in: query
        description: Maximum number of blobs to return.
        schema:
          type: integer
          minimum: 1
          maximum: 5000
        example: 10
      - name: include
        in: query
        description: 'Specifies one or more datasets to include in the response: snapshots, metadata, uncommittedblobs, copy, deleted, tags, versions, deletedwithversions, immutabilitypolicy, legalhold, permissions.'
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Successfully listed the blobs.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/BlobEnumerationResults'
              examples:
                ContainerListblobs200Example:
                  summary: Default Container_ListBlobs 200 response
                  x-microcks-default: true
                  value:
                    ServiceEndpoint: example_value
                    ContainerName: example_value
                    Prefix: example_value
                    Marker: example_value
                    MaxResults: 10
                    Blobs:
                      Blob:
                      - {}
                      BlobPrefix:
                      - Name: Example Title
                    NextMarker: example_value
        default:
          description: An error occurred.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
              examples:
                ContainerListblobsdefaultExample:
                  summary: Default Container_ListBlobs default response
                  x-microcks-default: true
                  value:
                    Code: example_value
                    Message: example_value
                    AuthenticationErrorDetail: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: Container_Delete
      summary: Microsoft Azure Delete a Container
      description: Marks the specified container for deletion. The container and any blobs within it are later deleted.
      tags:
      - Containers
      parameters:
      - $ref: '#/components/parameters/ContainerNameParameter'
      - name: restype
        in: query
        required: true
        schema:
          type: string
          enum:
          - container
        example: container
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: x-ms-lease-id
        in: header
        description: Required if the container has an active lease.
        schema:
          type: string
        example: '500123'
      responses:
        '202':
          description: The container has been marked for deletion.
        default:
          description: An error occurred.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
              examples:
                ContainerDeletedefaultExample:
                  summary: Default Container_Delete default response
                  x-microcks-default: true
                  value:
                    Code: example_value
                    Message: example_value
                    AuthenticationErrorDetail: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /dbs/{databaseId}/colls:
    get:
      operationId: Containers_List
      summary: Microsoft Azure List Containers
      description: Returns a list of containers under the specified database.
      tags:
      - Containers
      parameters:
      - $ref: '#/components/parameters/DatabaseIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter_2'
      - $ref: '#/components/parameters/MaxItemCountParameter'
      - $ref: '#/components/parameters/ContinuationParameter'
      responses:
        '200':
          description: Successfully returned the list of containers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerListResult'
              examples:
                ContainersList200Example:
                  summary: Default Containers_List 200 response
                  x-microcks-default: true
                  value:
                    _rid: '500123'
                    DocumentCollections:
                    - id: abc123
                      defaultTtl: 10
                      _rid: '500123'
                      _ts: 10
                      _self: example_value
                      _etag: example_value
                      _docs: example_value
                      _sprocs: example_value
                      _triggers: example_value
                      _udfs: example_value
                    _count: 10
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ContainersListdefaultExample:
                  summary: Default Containers_List default response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: Containers_Create
      summary: Microsoft Azure Create a Container
      description: Creates a new container under the specified database.
      tags:
      - Containers
      parameters:
      - $ref: '#/components/parameters/DatabaseIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter_2'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContainerCreateRequest'
            examples:
              ContainersCreateRequestExample:
                summary: Default Containers_Create request
                x-microcks-default: true
                value:
                  id: abc123
                  indexingPolicy:
                    automatic: true
                    indexingMode: consistent
                    includedPaths:
                    - {}
                    excludedPaths:
                    - {}
                    compositeIndexes:
                    - {}
                    spatialIndexes:
                    - {}
                  partitionKey:
                    paths:
                    - {}
                    kind: Hash
                    version: 1
                  uniqueKeyPolicy:
                    uniqueKeys:
                    - {}
                  conflictResolutionPolicy:
                    mode: LastWriterWins
                    conflictResolutionPath: example_value
                    conflictResolutionProcedure: example_value
                  defaultTtl: 10
      responses:
        '201':
          description: Successfully created the container.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Container'
              examples:
                ContainersCreate201Example:
                  summary: Default Containers_Create 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    indexingPolicy:
                      automatic: true
                      indexingMode: consistent
                      includedPaths:
                      - {}
                      excludedPaths:
                      - {}
                      compositeIndexes:
                      - {}
                      spatialIndexes:
                      - {}
                    partitionKey:
                      paths:
                      - {}
                      kind: Hash
                      version: 1
                    uniqueKeyPolicy:
                      uniqueKeys:
                      - {}
                    conflictResolutionPolicy:
                      mode: LastWriterWins
                      conflictResolutionPath: example_value
                      conflictResolutionProcedure: example_value
                    defaultTtl: 10
                    _rid: '500123'
                    _ts: 10
                    _self: example_value
                    _etag: example_value
                    _docs: example_value
                    _sprocs: example_value
                    _triggers: example_value
                    _udfs: example_value
        '409':
          description: The container with the specified ID already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ContainersCreate409Example:
                  summary: Default Containers_Create 409 response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ContainersCreatedefaultExample:
                  summary: Default Containers_Create default response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /dbs/{databaseId}/colls/{containerId}:
    get:
      operationId: Containers_Get
      summary: Microsoft Azure Get a Container
      description: Retrieves a container resource by its ID.
      tags:
      - Containers
      parameters:
      - $ref: '#/components/parameters/DatabaseIdParameter'
      - $ref: '#/components/parameters/ContainerIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter_2'
      responses:
        '200':
          description: Successfully returned the container.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Container'
              examples:
                ContainersGet200Example:
                  summary: Default Containers_Get 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    indexingPolicy:
                      automatic: true
                      indexingMode: consistent
                      includedPaths:
                      - {}
                      excludedPaths:
                      - {}
                      compositeIndexes:
                      - {}
                      spatialIndexes:
                      - {}
                    partitionKey:
                      paths:
                      - {}
                      kind: Hash
                      version: 1
                    uniqueKeyPolicy:
                      uniqueKeys:
                      - {}
                    conflictResolutionPolicy:
                      mode: LastWriterWins
                      conflictResolutionPath: example_value
                      conflictResolutionProcedure: example_value
                    defaultTtl: 10
                    _rid: '500123'
                    _ts: 10
                    _self: example_value
                    _etag: example_value
                    _docs: example_value
                    _sprocs: example_value
                    _triggers: example_value
                    _udfs: example_value
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ContainersGetdefaultExample:
                  summary: Default Containers_Get default response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: Containers_Replace
      summary: Microsoft Azure Replace a Container
      description: Replaces the entire container resource.
      tags:
      - Containers
      parameters:
      - $ref: '#/components/parameters/DatabaseIdParameter'
      - $ref: '#/components/parameters/ContainerIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter_2'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContainerCreateRequest'
            examples:
              ContainersReplaceRequestExample:
                summary: Default Containers_Replace request
                x-microcks-default: true
                value:
                  id: abc123
                  indexingPolicy:
                    automatic: true
                    indexingMode: consistent
                    includedPaths:
                    - {}
                    excludedPaths:
                    - {}
                    compositeIndexes:
                    - {}
                    spatialIndexes:
                    - {}
                  partitionKey:
                    paths:
                    - {}
                    kind: Hash
                    version: 1
                  uniqueKeyPolicy:
                    uniqueKeys:
                    - {}
                  conflictResolutionPolicy:
                    mode: LastWriterWins
                    conflictResolutionPath: example_value
                    conflictResolutionProcedure: example_value
                  defaultTtl: 10
      responses:
        '200':
          description: Successfully replaced the container.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Container'
              examples:
                ContainersReplace200Example:
                  summary: Default Containers_Replace 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    indexingPolicy:
                      automatic: true
                      indexingMode: consistent
                      includedPaths:
                      - {}
                      excludedPaths:
                      - {}
                      compositeIndexes:
                      - {}
                      spatialIndexes:
                      - {}
                    partitionKey:
                      paths:
                      - {}
                      kind: Hash
                      version: 1
                    uniqueKeyPolicy:
                      uniqueKeys:
                      - {}
                    conflictResolutionPolicy:
                      mode: LastWriterWins
                      conflictResolutionPath: example_value
                      conflictResolutionProcedure: example_value
                    defaultTtl: 10
                    _rid: '500123'
                    _ts: 10
                    _self: example_value
                    _etag: example_value
                    _docs: example_value
                    _sprocs: example_value
                    _triggers: example_value
                    _udfs: example_value
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ContainersReplacedefaultExample:
                  summary: Default Containers_Replace default response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: Containers_Delete
      summary: Microsoft Azure Delete a Container
      description: Deletes a container and all contained items.
      tags:
      - Containers
      parameters:
      - $ref: '#/components/parameters/DatabaseIdParameter'
      - $ref: '#/components/parameters/ContainerIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter_2'
      responses:
        '204':
          description: Successfully deleted the container.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ContainersDeletedefaultExample:
                  summary: Default Containers_Delete default response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers
  : get:
      tags:
      - Containers
      summary: Microsoft Azure Lists All The Containers Of A Storage Account In A Data Box Edge Data Box Gateway Device
      operationId: microsoftAzureContainersListbystorageaccount
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: storageAccountName
        in: path
        description: The storage Account name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The collection of all the containers on the device.
          schema:
            $ref: '#/definitions/ContainerList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ContainerListAllInDevice:
          $ref: ./examples/ContainerListAllInDevice.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}
  : get:
      tags:
      - Containers
      summary: Microsoft Azure Gets A Container By Name
      operationId: microsoftAzureContainersGet
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: storageAccountName
        in: path
        description: The Storage Account Name
        required: true
        type: string
      - name: containerName
        in: path
        description: The container Name
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The container details.
          schema:
            $ref: '#/definitions/Container'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        ContainerGet:
          $ref: ./examples/ContainerGet.json
      description: Needs a more full description created.
    put:
      tags:
      - Containers
      summary: Microsoft Azure Creates A New Container Or Updates An Existing Container On The Device
      operationId: microsoftAzureContainersCreateorupdate
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: storageAccountName
        in: path
        description: The Storage Account Name
        required: true
        type: string
      - name: containerName
        in: path
        description: The container name.
        required: true
        type: string
      - name: container
        in: body
        description: The container properties.
        required: true
        schema:
          $ref: '#/definitions/Container'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the container.
          schema:
            $ref: '#/definitions/Container'
        '202':
          description: Accepted the request to create or update the container.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        ContainerPut:
          $ref: ./examples/ContainerPut.json
      description: Needs a more full description created.
    delete:
      tags:
      - Containers
      description: Deletes the container on the Data Box Edge/Data Box Gateway device.
      operationId: microsoftAzureContainersDelete
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: storageAccountName
        in: path
        description: The Storage Account Name
        required: true
        type: string
      - name: containerName
        in: path
        description: The container name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '202':
          description: Accepted the request to delete the container.
        '204':
          description: The container is already deleted.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        ContainerDelete:
          $ref: ./examples/ContainerDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Storageaccounts Storageaccountname Containers Containername
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}/refresh
  : post:
      tags:
      - Containers
      summary: Microsoft Azure Refreshes The Container Metadata With The Data From The Cloud
      operationId: microsoftAzureContainersRefresh
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: storageAccountName
        in: path
        description: The Storage Account Name
        required: true
        type: string
      - name: containerName
        in: path
        description: The container name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully refreshed the container on the device.
        '202':
          description: Accepted the request to refresh the container on the device.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        ContainerRefresh:
          $ref: ./examples/ContainerRefresh.json
      description: Needs a more full description created.
components:
  parameters:
    ContainerNameParameter:
      name: containerName
      in: path
      required: true
      description: The name of the container.
      schema:
        type: string
        minLength: 3
        maxLength: 63
        pattern: ^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){1,61}[a-z0-9]$
    DatabaseIdParameter:
      name: databaseId
      in: path
      required: true
      description: The ID of the database.
      schema:
        type: string
    ContainerIdParameter:
      name: containerId
      in: path
      required: true
      description: The ID of the container (collection).
      schema:
        type: string
    ContinuationParameter:
      name: x-ms-continuation
      in: header
      description: A continuation token returned from a previous request for pagination.
      schema:
        type: string
    ApiVersionParameter_2:
      name: x-ms-version
      in: header
      required: true
      description: The version of the Cosmos DB REST API.
      schema:
        type: string
        default: '2018-12-31'
    ApiVersionParameter:
      name: x-ms-version
      in: header
      required: true
      description: Specifies the version of the operation to use for this request.
      schema:
        type: string
        default: '2024-05-04'
    MaxItemCountParameter:
      name: x-ms-max-item-count
      in: header
      description: The maximum number of items to return per page. Default is 100, maximum is 1000.
      schema:
        type: integer
        default: 100
        maximum: 1000
  schemas:
    ErrorResponse:
      type: object
      description: Error response from Cosmos DB.
      properties:
        code:
          type: string
          description: The error code.
          example: example_value
        message:
          type: string
          description: The error message.
          example: example_value
      required:
      - code
      - message
    ContainerCreateRequest:
      type: object
      description: Request body for creating or replacing a container.
      properties:
        id:
          type: string
          description: The unique name that identifies the container.
          example: abc123
        indexingPolicy:
          $ref: '#/components/schemas/IndexingPolicy'
        partitionKey:
          $ref: '#/components/schemas/PartitionKeyDefinition'
        uniqueKeyPolicy:
          $ref: '#/components/schemas/UniqueKeyPolicy'
        conflictResolutionPolicy:
          $ref: '#/components/schemas/ConflictResolutionPolicy'
        defaultTtl:
          type: integer
          description: Default time-to-live in seconds.
          example: 10
      required:
      - id
      - partitionKey
    BlobItem:
      type: object
      description: A blob item in the enumeration results.
      properties:
        Name:
          type: string
          description: The name of the blob.
          example: Example Title
        Deleted:
          type: boolean
          description: Whether the blob is deleted.
          example: true
        Snapshot:
          type: string
          description: The snapshot DateTime.
          example: example_value
        VersionId:
          type: string
          description: The version ID of the blob.
          example: '500123'
        IsCurrentVersion:
          type: boolean
          description: Whether this is the current version.
          example: true
        Properties:
          $ref: '#/components/schemas/BlobProperties'
        Metadata:
          type: object
          additionalProperties:
            type: string
          description: The blob metadata.
          example: example_value
        Tags:
          type: object
          description: Blob tags.
          properties:
            TagSet:
              type: array
              items:
                type: object
                properties:
                  Key:
                    type: string
                  Value:
                    type: string
          example: example_value
      required:
      - Name
      - Properties
    ContainerListResult:

# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-containers-api-openapi.yml