# 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 ExternalIdentities CIAM Tenants API
  version: 1.0.0
extends: openapi/microsoft-azure-ciamtenants-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: 7
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.AzureActiveDirectory/checkNameAvailability'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if a customer tenant domain name is free
      effect: read
      questions:
      - Is the domain name I want for my Azure AD for customers tenant available?
      - Does the country code affect tenant name availability?
      instructions:
      - text: Check if tenant name {name} is available in country {country} for subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          name: requestBody.name
          country: requestBody.countryCode
      - text: Verify {name} can be used as a new customer tenant domain.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/ciamDirectories'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer tenants in a resource group
      effect: read
      questions:
      - Which Azure AD for customers tenants live in this resource group?
      - How do I list CIAM directories scoped to one resource group?
      instructions:
      - text: List all customer tenants in this resource group.
      - text: Show CIAM directories in the current resource group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.AzureActiveDirectory/ciamDirectories'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer tenants in a subscription
      effect: read
      questions:
      - What customer identity tenants exist across my subscription?
      - Can I see all CIAM directories without picking a resource group?
      instructions:
      - text: List every customer tenant in my subscription.
      - text: Show all CIAM directories subscription-wide.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/ciamDirectories/{resourceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer tenant resource
      effect: read
      questions:
      - How do I view the settings of one Azure AD for customers tenant?
      - What SKU and properties does my CIAM tenant resource have?
      instructions:
      - text: Get customer tenant {tenant}.
        slots:
          tenant: path.resourceName
      - text: Show the CIAM directory resource {tenant}.
        slots:
          tenant: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/ciamDirectories/{resourceName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a customer identity tenant
      effect: write
      questions:
      - How do I create a new Azure AD for customers tenant linked to my subscription?
      - Should I check the name first before creating a CIAM tenant?
      instructions:
      - text: Create customer tenant {tenant} in {location} with SKU {sku}.
        slots:
          tenant: path.resourceName
          location: requestBody.location
          sku: requestBody.sku
      - text: Provision CIAM directory {tenant} with properties {properties}.
        slots:
          tenant: path.resourceName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/ciamDirectories/{resourceName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer identity tenant resource
      effect: destructive
      questions:
      - How do I delete an Azure AD for customers tenant and its Azure resource?
      - Is deleting the CIAM resource the last step in removing a tenant?
      instructions:
      - text: Delete customer tenant {tenant}.
        slots:
          tenant: path.resourceName
      - text: Remove the CIAM directory resource {tenant} from Azure.
        slots:
          tenant: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/ciamDirectories/{resourceName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a customer tenant's SKU or tags
      effect: write
      questions:
      - Can I change the SKU of my customer identity tenant?
      - How do I update tags on a CIAM directory?
      instructions:
      - text: Change customer tenant {tenant} to SKU {sku}.
        slots:
          tenant: path.resourceName
          sku: requestBody.sku
      - text: Set tags {tags} on CIAM directory {tenant}.
        slots:
          tags: requestBody.tags
          tenant: path.resourceName
      method: generated
      generated: '2026-09-26'