Azure Data Factory · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataFactoryManagementClient Global Parameters API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}'].delete

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 DataFactoryManagementClient Global Parameters API
  version: 1.0.0
extends: openapi/microsoft-azure-data-factory-globalparameters-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: 4
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters'].get
  update:
    x-apievangelist-phrasing:
      intent: List global parameters in a factory
      effect: read
      questions:
      - Which global parameters are defined in my data factory?
      - Can I see every factory-wide parameter my pipelines can reference?
      instructions:
      - text: List the global parameters in factory {factory}.
        slots:
          factory: path.factoryName
      - text: Show all global parameters for {factory}.
        slots:
          factory: path.factoryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a global parameter
      effect: read
      questions:
      - How do I read the value of one global parameter?
      - What is a specific global parameter currently set to in my factory?
      instructions:
      - text: Get global parameter {param} from factory {factory}.
        slots:
          factory: path.factoryName
          param: path.globalParameterName
      - text: Show the value of global parameter {param} in {factory}.
        slots:
          factory: path.factoryName
          param: path.globalParameterName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a global parameter
      effect: write
      questions:
      - How do I add a new global parameter to a data factory?
      - Can I change the value of an existing global parameter through the API?
      instructions:
      - text: Create global parameter {param} in factory {factory} with properties {properties}.
        slots:
          factory: path.factoryName
          param: path.globalParameterName
          properties: requestBody.properties
      - text: Set global parameter {param} in {factory} to {properties}.
        slots:
          factory: path.factoryName
          param: path.globalParameterName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a global parameter
      effect: destructive
      questions:
      - Can I delete a global parameter from a factory?
      - What removes a global parameter pipelines no longer reference?
      instructions:
      - text: Delete global parameter {param} from factory {factory}.
        slots:
          factory: path.factoryName
          param: path.globalParameterName
      - text: Remove the {param} global parameter in {factory}.
        slots:
          factory: path.factoryName
          param: path.globalParameterName
      method: generated
      generated: '2026-09-26'