Microsoft Entra ID (formerly Azure AD) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity.SignIns Policies.feature Rollout Policy API

14 actions 14 updates phrasing extends openapi/azure-ad-policies-featurerolloutpolicy-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Entra ID (formerly Azure AD)'s API. It is a proposal applied on top of the contract, not a document Microsoft Entra ID (formerly Azure AD) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 14

$.info
$.paths['/policies/featureRolloutPolicies'].get
$.paths['/policies/featureRolloutPolicies'].post
$.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}'].get
$.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}'].delete
$.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}'].patch
$.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo'].get
$.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo'].post
$.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo/{directoryObject-id}/$ref'].delete
$.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo/$count'].get
$.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo/$ref'].get
$.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo/$ref'].post
$.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo/$ref'].delete
$.paths['/policies/featureRolloutPolicies/$count'].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 Identity.SignIns Policies.feature Rollout Policy API
  version: 1.0.0
extends: openapi/azure-ad-policies-featurerolloutpolicy-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: 13
- target: $.paths['/policies/featureRolloutPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List feature rollout policies
      effect: read
      questions:
      - Which staged rollout policies are set up in my Entra tenant?
      - Can I filter feature rollout policies to find ones that are enabled?
      instructions:
      - text: List all feature rollout policies.
      - text: Show feature rollout policies matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/featureRolloutPolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a feature rollout policy
      effect: write
      questions:
      - How do I start a staged rollout of a feature like passthrough authentication to some users?
      - Can a new feature rollout policy be created already enabled?
      instructions:
      - text: Create a feature rollout policy named {name} for feature {feature}.
        slots:
          name: requestBody.displayName
          feature: requestBody.feature
      - text: Create an enabled {enabled} rollout policy {name} for {feature} described as {description}.
        slots:
          enabled: requestBody.isEnabled
          name: requestBody.displayName
          feature: requestBody.feature
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a feature rollout policy
      effect: read
      questions:
      - What feature and settings does one staged rollout policy have?
      - Is a specific feature rollout policy currently enabled?
      instructions:
      - text: Get feature rollout policy {policy}.
        slots:
          policy: path.featureRolloutPolicy-id
      - text: Show whether rollout policy {policy} is enabled and for which feature.
        slots:
          policy: path.featureRolloutPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a feature rollout policy
      effect: destructive
      questions:
      - How do I delete a staged rollout policy I'm finished with?
      - Can I remove a feature rollout policy entirely?
      instructions:
      - text: Delete feature rollout policy {policy}.
        slots:
          policy: path.featureRolloutPolicy-id
      - text: Remove staged rollout policy {policy} from the tenant.
        slots:
          policy: path.featureRolloutPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a feature rollout policy
      effect: write
      questions:
      - How do I turn off an existing staged rollout policy?
      - Can I apply an existing feature rollout policy to the whole organization?
      instructions:
      - text: Set enabled to {enabled} on feature rollout policy {policy}.
        slots:
          enabled: requestBody.isEnabled
          policy: path.featureRolloutPolicy-id
      - text: Update rollout policy {policy} so applied-to-organization is {orgWide}.
        slots:
          policy: path.featureRolloutPolicy-id
          orgWide: requestBody.isAppliedToOrganization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo'].get
  update:
    x-apievangelist-phrasing:
      intent: List who a feature rollout applies to
      effect: read
      questions:
      - Which groups or objects is a staged rollout feature enabled for?
      - What directory objects are included in a feature rollout policy?
      instructions:
      - text: List the directory objects feature rollout policy {policy} applies to.
        slots:
          policy: path.featureRolloutPolicy-id
      - text: Show the top {top} objects included in rollout policy {policy}.
        slots:
          top: query.$top
          policy: path.featureRolloutPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a directory object to a feature rollout
      effect: write
      questions:
      - How do I add a group to a staged rollout by posting the directory object?
      - Can I include another directory object in a feature rollout policy?
      instructions:
      - text: Add directory object {object} to feature rollout policy {policy}.
        slots:
          object: requestBody.id
          policy: path.featureRolloutPolicy-id
      - text: Include group object {object} in the appliesTo list of rollout {policy}.
        slots:
          object: requestBody.id
          policy: path.featureRolloutPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo/{directoryObject-id}/$ref'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one object from a feature rollout
      effect: destructive
      questions:
      - How do I take a specific group out of a staged rollout by its ID?
      - Can I remove one directory object from a feature rollout policy?
      instructions:
      - text: Remove directory object {object} from feature rollout policy {policy}.
        slots:
          object: path.directoryObject-id
          policy: path.featureRolloutPolicy-id
      - text: Take object {object} out of rollout {policy} using its path ID.
        slots:
          object: path.directoryObject-id
          policy: path.featureRolloutPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count objects in a feature rollout
      effect: read
      questions:
      - How many groups or objects is a staged rollout applied to?
      - What is the number of directory objects in one feature rollout policy?
      instructions:
      - text: Count the objects feature rollout policy {policy} applies to.
        slots:
          policy: path.featureRolloutPolicy-id
      - text: Give me the number of appliesTo members on rollout {policy} matching {filter}.
        slots:
          policy: path.featureRolloutPolicy-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo/$ref'].get
  update:
    x-apievangelist-phrasing:
      intent: List references of a feature rollout's targets
      effect: read
      questions:
      - What are the $ref links of objects a feature rollout applies to?
      - Can I get only the reference IDs of a staged rollout's targets?
      instructions:
      - text: List the $ref links of appliesTo objects on rollout policy {policy}.
        slots:
          policy: path.featureRolloutPolicy-id
      - text: Show only reference IDs of targets in feature rollout {policy}.
        slots:
          policy: path.featureRolloutPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo/$ref'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a directory object to a feature rollout
      effect: write
      questions:
      - How do I add a group to a staged rollout using its reference URL?
      - Can I link an existing directory object to a feature rollout by @odata.id?
      instructions:
      - text: Link object reference {ref} to feature rollout policy {policy}.
        slots:
          ref: requestBody.@odata.id
          policy: path.featureRolloutPolicy-id
      - text: Add the group at {ref} to staged rollout {policy} by reference.
        slots:
          ref: requestBody.@odata.id
          policy: path.featureRolloutPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo/$ref'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink an object from a rollout by reference
      effect: destructive
      questions:
      - How do I remove a group from a staged rollout by passing its @id reference?
      - Can I unlink a rollout target using its reference URL instead of a path ID?
      instructions:
      - text: Unlink the object with reference {ref} from rollout policy {policy}.
        slots:
          ref: query.@id
          policy: path.featureRolloutPolicy-id
      - text: Remove target {ref} from feature rollout {policy} via the @id query.
        slots:
          ref: query.@id
          policy: path.featureRolloutPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/featureRolloutPolicies/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count feature rollout policies
      effect: read
      questions:
      - How many staged rollout policies exist in my tenant?
      - What is the total number of feature rollout policies?
      instructions:
      - text: Count the feature rollout policies.
      - text: Give me the number of rollout policies matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'