# 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 Secrets API
  version: 1.0.0
extends: openapi/microsoft-azure-secrets-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: 9
- target: $.paths['/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List secrets in a Key Vault
      effect: read
      questions:
      - Which secrets are stored in my Azure Key Vault?
      - Does listing Key Vault secrets return their values or only identifiers and attributes?
      - Can I limit how many vault secrets come back per page?
      instructions:
      - text: List the secrets in my key vault.
      - text: Show up to {maxresults} secret identifiers from the vault.
        slots:
          maxresults: query.maxresults
      method: generated
      generated: '2026-09-26'
- target: $.paths['/secrets/{secret-name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a secret in a Key Vault
      effect: write
      questions:
      - How do I store a new secret value in Azure Key Vault?
      - What happens if I set a Key Vault secret whose name already exists?
      instructions:
      - text: Set Key Vault secret {secret-name} to {value}.
        slots:
          secret-name: path.secret-name
          value: requestBody.value
      - text: Store {value} in the vault as {secret-name} with content type {contentType}.
        slots:
          value: requestBody.value
          secret-name: path.secret-name
          contentType: requestBody.contentType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/secrets/{secret-name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a secret from a Key Vault
      effect: destructive
      questions:
      - Can I delete a secret from my key vault by name?
      - Does deleting a Key Vault secret remove all of its versions?
      instructions:
      - text: Delete Key Vault secret {secret-name}.
        slots:
          secret-name: path.secret-name
      - text: Remove the secret {secret-name} from my vault.
        slots:
          secret-name: path.secret-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/secrets/{secret-name}/{secret-version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific version of a Key Vault secret
      effect: read
      questions:
      - How do I read the value of a Key Vault secret at a particular version?
      - Can I retrieve an older version of a vault secret?
      instructions:
      - text: Get version {secret-version} of Key Vault secret {secret-name}.
        slots:
          secret-version: path.secret-version
          secret-name: path.secret-name
      - text: Read the value of vault secret {secret-name} at version {secret-version}.
        slots:
          secret-name: path.secret-name
          secret-version: path.secret-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List secrets in a DevTest Labs user profile
      effect: read
      questions:
      - Which secrets are saved in a DevTest Labs user's profile?
      - Can I filter or sort the secrets stored for a lab user?
      instructions:
      - text: List secrets for user {userName} in lab {labName} in resource group {resourceGroupName} of subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
          userName: path.userName
          labName: path.labName
          resourceGroupName: path.resourceGroupName
      - text: Show the top {top} secrets in lab {labName} for user {userName}.
        slots:
          top: query.$top
          labName: path.labName
          userName: path.userName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DevTest Labs user secret
      effect: read
      questions:
      - What does a specific secret in my DevTest Labs profile contain?
      - Can I look up one lab user secret by name?
      instructions:
      - text: Get secret {name} for user {userName} in lab {labName} in {resourceGroupName} of subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
          name: path.name
          userName: path.userName
          labName: path.labName
          resourceGroupName: path.resourceGroupName
      - text: Show lab {labName} secret {name} belonging to {userName}.
        slots:
          labName: path.labName
          name: path.name
          userName: path.userName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a DevTest Labs user secret
      effect: write
      questions:
      - How do I save a secret to a DevTest Labs user profile?
      - Can I overwrite an existing lab user secret, and how long does it take?
      instructions:
      - text: Create secret {name} for user {userName} in lab {labName} in {resourceGroupName} of subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
          name: path.name
          userName: path.userName
          labName: path.labName
          resourceGroupName: path.resourceGroupName
      - text: Replace the lab secret {name} for {userName} in {labName}.
        slots:
          name: path.name
          userName: path.userName
          labName: path.labName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DevTest Labs user secret
      effect: destructive
      questions:
      - Can I remove a secret from a DevTest Labs user profile?
      - Is deleting a lab user secret permanent?
      instructions:
      - text: Delete secret {name} for user {userName} in lab {labName} in {resourceGroupName} of subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
          name: path.name
          userName: path.userName
          labName: path.labName
          resourceGroupName: path.resourceGroupName
      - text: Remove lab {labName}'s secret {name} from {userName}'s profile.
        slots:
          labName: path.labName
          name: path.name
          userName: path.userName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update tags on a DevTest Labs user secret
      effect: write
      questions:
      - Can I change the tags on a DevTest Labs secret without touching its value?
      - Which properties of a lab user secret can be modified after creation?
      instructions:
      - text: Update the tags on secret {name} for user {userName} in lab {labName} in {resourceGroupName} of subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
          name: path.name
          userName: path.userName
          labName: path.labName
          resourceGroupName: path.resourceGroupName
      - text: Retag lab secret {name} owned by {userName} in {labName}.
        slots:
          name: path.name
          userName: path.userName
          labName: path.labName
      method: generated
      generated: '2026-09-26'