Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Environments API

30 actions 30 updates phrasing extends openapi/microsoft-azure-environments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 30 · first 16 shown; the file carries all of them

$.info
$.paths['/environments'].get
$.paths['/projects/{projectName}/environments'].get
$.paths['/projects/{projectName}/users/{userId}/environments'].get
$.paths['/projects/{projectName}/users/{userId}/environments/{environmentName}'].get
$.paths['/projects/{projectName}/users/{userId}/environments/{environmentName}'].put
$.paths['/projects/{projectName}/users/{userId}/environments/{environmentName}'].delete
$.paths['/projects/{projectName}/users/{userId}/environments/{environmentName}/operations'].get
$.paths['/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}'].get
$.paths['/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}/logs'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments'].get

OpenAPI Overlay

Raw ↑
# 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 Environments API
  version: 1.0.0
extends: openapi/microsoft-azure-environments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 29
- target: $.paths['/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployment environments across all workspaces
      effect: read
      questions:
      - Can I see every deployment environment I have across all dev center workspaces at once?
      - What query options page through the full cross-workspace environment list?
      instructions:
      - text: List all my deployment environments across every workspace.
      - text: List the first {top} deployment environments across all workspaces.
        slots:
          top: query.top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectName}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List the deployment environments in a dev center project
      effect: read
      questions:
      - Which deployment environments exist in my dev center project, regardless of owner?
      - How do I see all environments that belong to one dev center project?
      instructions:
      - text: List every deployment environment in dev center project {project}.
        slots:
          project: path.projectName
      - text: Show all project-level environments in the dev center, for all users.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectName}/users/{userId}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's deployment environments in a project
      effect: read
      questions:
      - Which deployment environments does a specific user own in a dev center project?
      - How can I find the environments one developer has created in a project?
      instructions:
      - text: List the deployment environments owned by user {user} in dev center project {project}.
        slots:
          user: path.userId
          project: path.projectName
      - text: Show only my own environments in this dev center project.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectName}/users/{userId}/environments/{environmentName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's deployment environment
      effect: read
      questions:
      - How do I look up the details of one deployment environment a user owns?
      - What is the provisioning state of a specific dev center environment?
      instructions:
      - text: Get deployment environment {environmentName} for user {user} in project {project}.
        slots:
          environmentName: path.environmentName
          user: path.userId
          project: path.projectName
      - text: Show the provisioning state of dev center environment {environmentName}.
        slots:
          environmentName: path.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectName}/users/{userId}/environments/{environmentName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a deployment environment
      effect: write
      questions:
      - How do I spin up a new deployment environment from a catalog environment definition?
      - Which environment type and catalog must I pick when creating a dev center environment?
      instructions:
      - text: Create deployment environment {environmentName} from definition {environmentDefinitionName} in catalog {catalogName} as type {environmentType}.
        slots:
          environmentName: path.environmentName
          environmentDefinitionName: requestBody.environmentDefinitionName
          catalogName: requestBody.catalogName
          environmentType: requestBody.environmentType
      - text: Replace user {user}'s environment {environmentName} in project {project} using catalog {catalogName} and definition {environmentDefinitionName}.
        slots:
          user: path.userId
          environmentName: path.environmentName
          project: path.projectName
          catalogName: requestBody.catalogName
          environmentDefinitionName: requestBody.environmentDefinitionName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectName}/users/{userId}/environments/{environmentName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deployment environment and its resources
      effect: destructive
      questions:
      - Can I tear down a dev center deployment environment along with all the resources it created?
      - What gets removed when I delete a user's deployment environment?
      instructions:
      - text: Delete dev center deployment environment {environmentName} and all its resources.
        slots:
          environmentName: path.environmentName
      - text: Tear down user {user}'s deployment environment {environmentName} in project {project}.
        slots:
          user: path.userId
          environmentName: path.environmentName
          project: path.projectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectName}/users/{userId}/environments/{environmentName}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent operations on a deployment environment
      effect: read
      questions:
      - What actions have run against my deployment environment in the last 90 days?
      - How far back does the operation history for a dev center environment go?
      instructions:
      - text: List the operations run on deployment environment {environmentName} in the past 90 days.
        slots:
          environmentName: path.environmentName
      - text: Show the action history for user {user}'s environment {environmentName} in project {project}.
        slots:
          user: path.userId
          environmentName: path.environmentName
          project: path.projectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of a deployment environment operation
      effect: read
      questions:
      - How do I check whether a specific action on my deployment environment succeeded?
      - Where can I see the outcome of one environment operation by its ID?
      instructions:
      - text: Get the result of operation {operationId} on deployment environment {environmentName}.
        slots:
          operationId: path.operationId
          environmentName: path.environmentName
      - text: Check the status of action {operationId} on user {user}'s environment {environmentName} in project {project}.
        slots:
          operationId: path.operationId
          user: path.userId
          environmentName: path.environmentName
          project: path.projectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get logs for a deployment environment operation
      effect: read
      questions:
      - Can I read the deployment logs for an action that ran on my dev center environment?
      - Where do I find the log output of a failed environment operation?
      instructions:
      - text: Get the logs for operation {operationId} on deployment environment {environmentName}.
        slots:
          operationId: path.operationId
          environmentName: path.environmentName
      - text: Download log output of operation {operationId} on {environmentName}, owned by {user} in project {project}.
        slots:
          operationId: path.operationId
          environmentName: path.environmentName
          user: path.userId
          project: path.projectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments in a DevTest Labs user profile
      effect: read
      questions:
      - Which environments does a user have in my DevTest Labs lab?
      - Can I filter or sort the DevTest Labs environments in someone's user profile?
      instructions:
      - text: List DevTest Labs environments for user {userName} in lab {labName}, resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          userName: path.userName
          labName: path.labName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the top {top} environments of user {userName} in DevTest lab {labName} in group {resourceGroupName}, filtered by {filter}.
        slots:
          top: query.$top
          userName: path.userName
          labName: path.labName
          resourceGroupName: path.resourceGroupName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DevTest Labs environment
      effect: read
      questions:
      - How do I read the details of one environment in a DevTest Labs user profile?
      - What properties does a single DevTest Labs environment expose?
      instructions:
      - text: Get DevTest Labs environment {name} of user {userName} in lab {labName}, group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          userName: path.userName
          labName: path.labName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the DevTest lab {labName} environment {name} belonging to {userName} in {resourceGroupName}.
        slots:
          labName: path.labName
          name: path.name
          userName: path.userName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a DevTest Labs environment
      effect: write
      questions:
      - How do I deploy a new environment into a user's DevTest Labs profile?
      - Why does creating a DevTest Labs environment take a while to finish?
      instructions:
      - text: Create DevTest Labs environment {name} for {userName} in lab {labName} ({subscriptionId}/{resourceGroupName}) with properties {properties}.
        slots:
          name: path.name
          userName: path.userName
          labName: path.labName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          properties: requestBody.properties
      - text: Replace the DevTest lab {labName} environment {name} for {userName} in {resourceGroupName}.
        slots:
          labName: path.labName
          name: path.name
          userName: path.userName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DevTest Labs environment
      effect: destructive
      questions:
      - Can I remove an environment from a user's DevTest Labs profile?
      - How long does deleting a DevTest Labs environment usually take?
      instructions:
      - text: Delete DevTest Labs environment {name} of user {userName} in lab {labName}, group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          userName: path.userName
          labName: path.labName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove the DevTest lab {labName} environment {name} owned by {userName} in {resourceGroupName}.
        slots:
          labName: path.labName
          name: path.name
          userName: path.userName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update tags on a DevTest Labs environment
      effect: write
      questions:
      - Can I change only the tags on a DevTest Labs environment?
      - Which DevTest Labs environment properties can be modified after creation?
      instructions:
      - text: Set tags {tags} on DevTest Labs environment {name} of {userName} in lab {labName} ({subscriptionId}/{resourceGroupName}).
        slots:
          tags: requestBody.tags
          name: path.name
          userName: path.userName
          labName: path.labName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
      - text: Retag DevTest lab {labName} environment {name} of {userName} in {resourceGroupName}.
        slots:
          labName: path.labName
          name: path.name
          userName: path.userName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List Lab Services environments in an environment setting
      effect: read
      questions:
      - Which student environments exist under a Lab Services environment setting?
      - Can I filter or order the environments in a classroom lab's environment setting?
      instructions:
      - text: List Lab Services environments in {subscriptionId}/{resourceGroupName}, lab account {labAccountName}, lab {labName}, setting {environmentSettingName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          labAccountName: path.labAccountName
          labName: path.labName
          environmentSettingName: path.environmentSettingName
      - text: Show the first {top} classroom lab environments in setting {environmentSettingName} of lab {labName}, account {labAccountName}, group {resourceGroupName}.
        slots:
          top: query.$top
          environmentSettingName: path.environmentSettingName
          labName: path.labName
          labAccountName: path.labAccountName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Lab Services environment
      effect: read
      questions:
      - How do I look up one classroom lab environment under an environment setting?
      - What details does a single Lab Services environment return?
      instructions:
      - text: Get Lab Services environment {environmentName} under {subscriptionId}/{resourceGroupName}/{labAccountName}/{labName}/{environmentSettingName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          labAccountName: path.labAccountName
          labName: path.labName
          environmentSettingName: path.environmentSettingName
          environmentName: path.environmentName
      - text: Show classroom lab environment {environmentName} under setting {environmentSettingName} in lab {labName} ({labAccountName}, {resourceGroupName}).
        slots:
          environmentName: path.environmentName
          environmentSettingName: path.environmentSettingName
          labName: path.labName
          labAccountName: path.labAccountName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a Lab Services environment
      effect: write
      questions:
      - How do I add a new environment to a classroom lab's environment setting?
      - Can I overwrite an existing Lab Services environment with new properties?
      instructions:
      - text: Create Lab Services environment {environmentName} under {subscriptionId}/{resourceGroupName}/{labAccountName}/{labName}/{environmentSettingName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          labAccountName: path.labAccountName
          labName: path.labName
          environmentSettingName: path.environmentSettingName
          environmentName: path.environmentName
      - text: Replace classroom lab environment {environmentName} under setting {environmentSettingName} in lab {labName} ({labAccountName}, {resourceGroupName}).
        slots:
          environmentName: path.environmentName
          environmentSettingName: path.environmentSettingName
          labName: path.labName
          labAccountName: path.labAccountName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Lab Services environment
      effect: destructive
      questions:
      - Can I remove a student environment from a Lab Services environment setting?
      - What happens when I delete a classroom lab environment?
      instructions:
      - text: Delete Lab Services environment {environmentName} under {subscriptionId}/{resourceGroupName}/{labAccountName}/{labName}/{environmentSettingName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          labAccountName: path.labAccountName
          labName: path.labName
          environmentSettingName: path.environmentSettingName
          environmentName: path.environmentName
      - text: Remove classroom lab environment {environmentName} from setting {environmentSettingName} in lab {labName} ({labAccountName}, {resourceGroupName}).
        slots:
          environmentName: path.environmentName
          environmentSettingName: path.environmentSettingName
          labName: path.labName
          labAccountName: path.labAccountName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Modify a Lab Services environment
      effect: write
      questions:
      - How do I change properties of an existing classroom lab environment?
      - Can I patch tags or location on a Lab Services environment?
      instructions:
      - text: Update Lab Services environment {environmentName} under {subscriptionId}/{resourceGroupName}/{labAccountName}/{labName}/{environmentSettingName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          labAccountName: path.labAccountName
          labName: path.labName
          environmentSettingName: path.environmentSettingName
          environmentName: path.environmentName
      - text: Patch tags {tags} onto classroom lab environment {environmentName} in lab {labName}.
        slots:
          tags: requestBody.tags
          environmentName: path.environmentName
          labName: path.labName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/claim'].post
  update:
    x-apievangelist-phrasing:
      intent: Claim a Lab Services environment for a user
      effect: write
      questions:
      - How does a student claim an available classroom lab environment?
      - Can I assign a Lab Services environment to myself?
      instructions:
      - text: Claim Lab Services environment {environmentName} under {subscriptionId}/{resourceGroupName}/{labAccountName}/{labName}/{environmentSettingName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          labAccountName: path.labAccountName
          labName: path.labName
          environmentSettingName: path.environmentSettingName
          environmentName: path.environmentName
      - text: Assign classroom lab environment {environmentName} under setting {environmentSettingName} in lab {labName} ({labAccountName}, {resourceGroupName}) to me.
        slots:
          environmentName: path.environmentName
          environmentSettingName: path.environmentSettingName
          labName: path.labName
          labAccountName: path.labAccountName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/resetPassword'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset the user password on a Lab Services environment
      effect: write
      questions:
      - I forgot my classroom lab VM password; can it be reset?
      - What do I need to supply to reset the password on a Lab Services environment?
      instructions:
      - text: Reset the lab password on environment {environmentName} under {subscriptionId}/{resourceGroupName}/{labAccountName}/{labName}/{environmentSettingName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          labAccountName: path.labAccountName
          labName: path.labName
          environmentSettingName: path.environmentSettingName
          environmentName: path.environmentName
      - text: Set classroom lab password {password} for {username} on environment ID {environmentId}.
        slots:
          password: requestBody.password
          username: requestBody.username
          environmentId: requestBody.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a Lab Services environment
      effect: write
      questions:
      - How do I power on all the resources in my classroom lab environment?
      - Does starting a Lab Services environment start every resource inside it?
      instructions:
      - text: Start Lab Services environment {environmentName} under {subscriptionId}/{resourceGroupName}/{labAccountName}/{labName}/{environmentSettingName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          labAccountName: path.labAccountName
          labName: path.labName
          environmentSettingName: path.environmentSettingName
          environmentName: path.environmentName
      - text: Power on classroom lab environment {environmentName} under setting {environmentSettingName} in lab {labName} ({labAccountName}, {resourceGroupName}).
        slots:
          environmentName: path.environmentName
          environmentSettingName: path.environmentSettingName
          labName: path.labName
          labAccountName: path.labAccountName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a Lab Services environment
      effect: write
      questions:
      - How do I shut down a classroom lab environment to stop paying for it?
      - Does stopping a Lab Services environment stop all its resources?
      instructions:
      - text: Stop Lab Services environment {environmentName} under {subscriptionId}/{resourceGroupName}/{labAccountName}/{labName}/{environmentSettingName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          labAccountName: path.labAccountName
          labName: path.labName
          environmentSettingName: path.environmentSettingName
          environmentName: path.environmentName
      - text: Shut down classroom lab environment {environmentName} under setting {environmentSettingName} in lab {labName} ({labAccountName}, {resourceGroupName}).
        slots:
          environmentName: path.environmentName
          environmentSettingName: path.environmentSettingName
          labName: path.labName
          labAccountName: path.labAccountName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Time Series Insights environment
      effect: read
      questions:
      - How do I look up a Time Series Insights environment by name?
      - Can I expand extra details when fetching a Time Series Insights environment?
      instructions:
      - text: Get Time Series Insights environment {environmentName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          environmentName: path.environmentName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the TSI environment {environmentName} in {resourceGroupName} expanded with {expand}.
        slots:
          environmentName: path.environmentName
          resourceGroupName: path.resourceGroupName
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a Time Series Insights environment
      effect: write
      questions:
      - How do I provision a new Time Series Insights environment with a SKU and location?
      - Which kind and SKU are required to create a Time Series Insights environment?
      instructions:
      - text: 'Create Time Series Insights environment {environmentName} in {subscriptionId}/{resourceGroupName}: kind {kind}, SKU {sku}, location {location}.'
        slots:
          environmentName: path.environmentName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          kind: requestBody.kind
          sku: requestBody.sku
          location: requestBody.location
      - text: Provision a TSI environment named {environmentName} in resource group {resourceGroupName} located in {location} with SKU {sku} and kind {kind}.
        slots:
          environmentName: path.environmentName
          resourceGroupName: path.resourceGroupName
          location: requestBody.location
          sku: requestBody.sku
          kind: requestBody.kind
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Time Series Insights environment
      effect: destructive
      questions:
      - Can I delete a Time Series Insights environment I no longer need?
      - What do I need to remove a Time Series Insights environment from a resource group?
      instructions:
      - text: Delete Time Series Insights environment {environmentName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          environmentName: path.environmentName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove the TSI environment {environmentName} from {resourceGroupName}.
        slots:
          environmentName: path.environmentName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Time Series Insights environment
      effect: write
      questions:
      - How do I change tags on an existing Time Series Insights environment?
      - Can I patch a Time Series Insights environment without recreating it?
      instructions:
      - text: Update Time Series Insights environment {environmentName} in {subscriptionId}/{resourceGroupName} with kind {kind} and tags {tags}.
        slots:
          environmentName: path.environmentName
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          kind: requestBody.kind
          tags: requestBody.tags
      - text: Patch the TSI environment {environmentName} in resource group {resourceGroupName} as kind {kind}.
        slots:
          environmentName: path.environmentName
          resourceGroupName: path.resourceGroupName
          kind: requestBody.kind
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List Time Series Insights environments in a resource group
      effect: read
      questions:
      - Which Time Series Insights environments live in a given resource group?
      - How do I inventory TSI environments scoped to one resource group?
      instructions:
      - text: List Time Series Insights environments in resource group {resourceGroupName} of subscription {subscriptionId}.
        slots:
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show every TSI environment inside {resourceGroupName}.
        slots:
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/overlays/microsoft-azure-environments-api-phrasing-overlay.yaml

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-environments-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.