# 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 Azure Dedicated HSM Resource Provider…
  version: 1.0.0
extends: openapi/microsoft-azure-dedicatedhsms-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: 6
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dedicated HSM
      effect: read
      questions:
      - What is the provisioning state of my dedicated HSM?
      - Can I view the network settings of one dedicated hardware security module?
      instructions:
      - text: Get dedicated HSM {name} in resource group {resourceGroupName}.
        slots:
          resourceGroupName: path.resourceGroupName
          name: path.name
      - text: Show details of HSM {name} in {resourceGroupName}.
        slots:
          resourceGroupName: path.resourceGroupName
          name: path.name
      - text: In subscription {subscriptionId}, read dedicated HSM {name} from {resourceGroupName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a dedicated HSM
      effect: write
      questions:
      - How do I provision a dedicated HSM in a region?
      - Which settings are required to create a dedicated hardware security module?
      instructions:
      - text: Create dedicated HSM {name} in {resourceGroupName} at {location} with {properties}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          location: requestBody.location
          properties: requestBody.properties
      - text: Provision HSM {name} in {resourceGroupName}, location {location}, SKU {sku}, properties {properties}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          location: requestBody.location
          sku: requestBody.sku
          properties: requestBody.properties
      - text: In subscription {subscriptionId}, create or update HSM {name} in {resourceGroupName} at {location} with {properties}.
        slots:
          location: requestBody.location
          properties: requestBody.properties
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dedicated HSM
      effect: destructive
      questions:
      - How do I deprovision a dedicated HSM I no longer need?
      - Can I delete a dedicated hardware security module from a resource group?
      instructions:
      - text: Delete dedicated HSM {name} in {resourceGroupName}.
        slots:
          resourceGroupName: path.resourceGroupName
          name: path.name
      - text: Deprovision HSM {name} from resource group {resourceGroupName}.
        slots:
          resourceGroupName: path.resourceGroupName
          name: path.name
      - text: In subscription {subscriptionId}, delete dedicated HSM {name} from {resourceGroupName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update tags on a dedicated HSM
      effect: write
      questions:
      - Can I change the tags on an existing dedicated HSM?
      - What can be patched on a dedicated HSM after it's created?
      instructions:
      - text: Set tags {tags} on dedicated HSM {name} in {resourceGroupName}.
        slots:
          tags: requestBody.tags
          name: path.name
          resourceGroupName: path.resourceGroupName
      - text: Patch HSM {name} in {resourceGroupName} with new tags.
        slots:
          resourceGroupName: path.resourceGroupName
          name: path.name
      - text: In subscription {subscriptionId}, update the tags of HSM {name} in {resourceGroupName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs'].get
  update:
    x-apievangelist-phrasing:
      intent: List dedicated HSMs in a resource group
      effect: read
      questions:
      - Which dedicated HSMs are in a particular resource group?
      - Can I cap the number of HSMs returned for a resource group?
      instructions:
      - text: List dedicated HSMs in resource group {resourceGroupName}.
        slots:
          resourceGroupName: path.resourceGroupName
      - text: Show the first {top} HSMs in {resourceGroupName}.
        slots:
          top: query.$top
          resourceGroupName: path.resourceGroupName
      - text: In subscription {subscriptionId}, list the dedicated HSMs of group {resourceGroupName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs'].get
  update:
    x-apievangelist-phrasing:
      intent: List dedicated HSMs in a subscription
      effect: read
      questions:
      - How many dedicated HSMs do I have across my whole subscription?
      - Can I list every dedicated HSM regardless of resource group?
      instructions:
      - text: List all dedicated HSMs in my subscription.
      - text: Show up to {top} dedicated HSMs subscription-wide.
        slots:
          top: query.$top
      - text: List every dedicated HSM in subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'