# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Containers API
  version: 1.0.0
extends: openapi/microsoft-azure-containers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 13
- target: $.paths['/{containerName}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the blobs in a storage container
      effect: read
      questions:
      - What blobs are stored inside one of my storage containers?
      - Can I filter blobs by a name prefix or group them into virtual folders with a delimiter?
      - Is there a cap on how many blobs come back per listing page?
      instructions:
      - text: List blobs in container {container}.
        slots:
          container: path.containerName
      - text: List blobs in {container} whose names start with {prefix}.
        slots:
          container: path.containerName
          prefix: query.prefix
      - text: List up to {max} blobs in {container}, continuing from marker {marker}.
        slots:
          max: query.maxresults
          container: path.containerName
          marker: query.marker
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{containerName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a blob container
      effect: write
      questions:
      - How do I create a new blob container in my storage account?
      - Can I set the public access level when I create a blob container?
      - What happens if a blob container with that name already exists?
      instructions:
      - text: Create blob container {container}.
        slots:
          container: path.containerName
      - text: Create blob container {container} with public access level {access}.
        slots:
          container: path.containerName
          access: header.x-ms-blob-public-access
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{containerName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a blob container
      effect: destructive
      questions:
      - Does deleting a blob container also remove every blob inside it?
      - Can I delete a blob container that has an active lease?
      instructions:
      - text: Delete blob container {container}.
        slots:
          container: path.containerName
      - text: Mark blob container {container} for deletion using lease ID {lease}.
        slots:
          container: path.containerName
          lease: header.x-ms-lease-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dbs/{databaseId}/colls'].get
  update:
    x-apievangelist-phrasing:
      intent: List containers in a database
      effect: read
      questions:
      - Which containers exist in my database?
      - Can I page through a database's containers with a continuation token?
      instructions:
      - text: List containers in database {database}.
        slots:
          database: path.databaseId
      - text: List up to {max} containers in database {database}, continuing from {continuation}.
        slots:
          max: header.x-ms-max-item-count
          database: path.databaseId
          continuation: header.x-ms-continuation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dbs/{databaseId}/colls'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a container in a database
      effect: write
      questions:
      - What partition key do I need to create a new container in a database?
      - Can I set an indexing policy and a default time-to-live when creating a database container?
      instructions:
      - text: Create container {id} in database {database} partitioned on {partition_key}.
        slots:
          id: requestBody.id
          database: path.databaseId
          partition_key: requestBody.partitionKey
      - text: Create container {id} in {database} with partition key {partition_key} and default TTL {ttl}.
        slots:
          id: requestBody.id
          database: path.databaseId
          partition_key: requestBody.partitionKey
          ttl: requestBody.defaultTtl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dbs/{databaseId}/colls/{containerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database container by ID
      effect: read
      questions:
      - How do I read a container's partition key and indexing policy?
      - What does a database container resource look like when fetched by its ID?
      instructions:
      - text: Get container {container} in database {database}.
        slots:
          container: path.containerId
          database: path.databaseId
      - text: Show the definition of container {container} from {database}.
        slots:
          container: path.containerId
          database: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dbs/{databaseId}/colls/{containerId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a database container's definition
      effect: write
      questions:
      - Can I change a container's indexing policy after it was created?
      - Does replacing a container require sending its full definition again?
      instructions:
      - text: Replace container {container} in database {database} with id {id} and partition key {partition_key}.
        slots:
          container: path.containerId
          database: path.databaseId
          id: requestBody.id
          partition_key: requestBody.partitionKey
      - text: Replace the definition of {container} in {database}, setting indexing policy {indexing_policy}.
        slots:
          container: path.containerId
          database: path.databaseId
          indexing_policy: requestBody.indexingPolicy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dbs/{databaseId}/colls/{containerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database container and its items
      effect: destructive
      questions:
      - How do I drop a container and all of its items from a database?
      - Will deleting a database container wipe every item stored in it?
      instructions:
      - text: Delete container {container} from database {database}.
        slots:
          container: path.containerId
          database: path.databaseId
      - text: Drop {container} and all its items in {database}.
        slots:
          container: path.containerId
          database: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers'].get
  update:
    x-apievangelist-phrasing:
      intent: List containers on a Data Box Edge storage account
      effect: read
      questions:
      - Which containers are on a storage account of my Data Box Edge device?
      - Can I list the containers for a Data Box Gateway storage account?
      instructions:
      - text: List containers in storage account {account} on Data Box Edge device {device} in {resource_group}, subscription {subscription}.
        slots:
          account: path.storageAccountName
          device: path.deviceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the containers of {account} on device {device}.
        slots:
          account: path.storageAccountName
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a container on a Data Box Edge device
      effect: read
      questions:
      - How do I look up one container on a Data Box Edge device by name?
      - What properties does a device storage account container report?
      instructions:
      - text: Get container {container} in storage account {account} on device {device}, {resource_group}, subscription {subscription}.
        slots:
          container: path.containerName
          account: path.storageAccountName
          device: path.deviceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show Data Box Edge container {container} on {device}.
        slots:
          container: path.containerName
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a container on a device
      effect: write
      questions:
      - Can I add a container to a storage account on my Data Box Edge device?
      - Is it possible to update an existing container on a Data Box Gateway device?
      instructions:
      - text: Create container {container} in {account} on device {device} ({resource_group}, subscription {subscription}) with {properties}.
        slots:
          container: path.containerName
          account: path.storageAccountName
          device: path.deviceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
          properties: requestBody.properties
      - text: Update device container {container} on {device} with properties {properties}.
        slots:
          container: path.containerName
          device: path.deviceName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a container on a Data Box Edge device
      effect: destructive
      questions:
      - How do I delete a container from a Data Box Edge device?
      - Can I remove a Data Box Gateway container that is no longer used?
      instructions:
      - text: Delete container {container} from storage account {account} on device {device}, {resource_group}, subscription {subscription}.
        slots:
          container: path.containerName
          account: path.storageAccountName
          device: path.deviceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Remove device container {container} from {device}.
        slots:
          container: path.containerName
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh a device container's metadata from the cloud
      effect: write
      questions:
      - Can I pull the latest cloud data into a Data Box Edge container's metadata?
      - When should I refresh a device container's metadata?
      instructions:
      - text: Refresh container {container} in {account} on device {device}, {resource_group}, subscription {subscription}.
        slots:
          container: path.containerName
          account: path.storageAccountName
          device: path.deviceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Refresh cloud metadata for container {container} on {device}.
        slots:
          container: path.containerName
          device: path.deviceName
      method: generated
      generated: '2026-09-26'