# 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 Microsoft Storage Sync Actions API
  version: 1.0.0
extends: openapi/microsoft-azure-actions-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: 10
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prebackup'].post
  update:
    x-apievangelist-phrasing:
      intent: Prepare a cloud endpoint for backup
      effect: write
      questions:
      - What do I call before backing up an Azure file share that is part of a sync group?
      - Can I tell File Sync a backup of a cloud endpoint is about to start?
      instructions:
      - text: Run pre-backup on cloud endpoint {cloudEndpointName} in sync group {syncGroupName} of {storageSyncServiceName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      - text: Signal a backup is starting for file share {azureFileShare} on cloud endpoint {cloudEndpointName}, group {syncGroupName}, service {storageSyncServiceName}.
        slots:
          azureFileShare: requestBody.azureFileShare
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postbackup'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a cloud endpoint backup
      effect: write
      questions:
      - How do I notify File Sync that a cloud endpoint backup has finished?
      - Is there a post-backup step for an Azure file share in a sync group?
      instructions:
      - text: Run post-backup on cloud endpoint {cloudEndpointName} in sync group {syncGroupName} of {storageSyncServiceName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      - text: Mark the backup of share {azureFileShare} finished for endpoint {cloudEndpointName}, group {syncGroupName}, service {storageSyncServiceName}.
        slots:
          azureFileShare: requestBody.azureFileShare
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prerestore'].post
  update:
    x-apievangelist-phrasing:
      intent: Prepare a cloud endpoint for restore
      effect: write
      questions:
      - What has to happen before I restore files into a synced Azure file share?
      - Can I specify which files to restore when starting a cloud endpoint restore?
      instructions:
      - text: Run pre-restore on cloud endpoint {cloudEndpointName} in sync group {syncGroupName} of {storageSyncServiceName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      - text: Begin a restore from {sourceAzureFileShareUri} into endpoint {cloudEndpointName}, group {syncGroupName}, service {storageSyncServiceName}.
        slots:
          sourceAzureFileShareUri: requestBody.sourceAzureFileShareUri
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/restoreheartbeat'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a restore heartbeat for a cloud endpoint
      effect: write
      questions:
      - How do I keep a long-running cloud endpoint restore alive?
      - Does File Sync need a heartbeat while a restore is in progress?
      instructions:
      - text: Send a restore heartbeat for cloud endpoint {cloudEndpointName} in sync group {syncGroupName} of {storageSyncServiceName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      - text: Ping restore heartbeat on endpoint {cloudEndpointName}, group {syncGroupName}, service {storageSyncServiceName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postrestore'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a cloud endpoint restore
      effect: write
      questions:
      - How do I tell File Sync a file share restore has finished?
      - Can I report files that failed during a cloud endpoint restore?
      instructions:
      - text: Run post-restore on cloud endpoint {cloudEndpointName} in sync group {syncGroupName} of {storageSyncServiceName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      - text: Finish the restore on endpoint {cloudEndpointName}, group {syncGroupName}, service {storageSyncServiceName} with status {status}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/triggerChangeDetection'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger change detection on a synced file share
      effect: write
      questions:
      - How do I make File Sync pick up changes made directly on the Azure file share?
      - Can I limit change detection to one directory of a cloud endpoint?
      instructions:
      - text: Trigger change detection on cloud endpoint {cloudEndpointName} in sync group {syncGroupName} of {storageSyncServiceName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      - text: Detect changes under {directoryPath} on endpoint {cloudEndpointName}, group {syncGroupName}, service {storageSyncServiceName}.
        slots:
          directoryPath: requestBody.directoryPath
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/afsShareMetadataCertificatePublicKeys'].get
  update:
    x-apievangelist-phrasing:
      intent: Get file share metadata signing certificate keys
      effect: read
      questions:
      - Where do I get the public keys used to sign Azure file share metadata?
      - Which certificate public keys verify metadata for a cloud endpoint?
      instructions:
      - text: Get the metadata signing certificate public keys for cloud endpoint {cloudEndpointName} in {syncGroupName}, service {storageSyncServiceName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      - text: Show AFS share metadata public keys for endpoint {cloudEndpointName}, group {syncGroupName}, service {storageSyncServiceName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}/recallAction'].post
  update:
    x-apievangelist-phrasing:
      intent: Recall tiered files to a server endpoint
      effect: write
      questions:
      - How do I bring tiered files back down to my on-premises server from the cloud?
      - Can I recall only files matching a pattern on a server endpoint?
      instructions:
      - text: Recall files to server endpoint {serverEndpointName} in sync group {syncGroupName} of {storageSyncServiceName}.
        slots:
          serverEndpointName: path.serverEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      - text: Recall {recallPath} matching {pattern} on server endpoint {serverEndpointName}, group {syncGroupName}, service {storageSyncServiceName}.
        slots:
          recallPath: requestBody.recallPath
          pattern: requestBody.pattern
          serverEndpointName: path.serverEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}/triggerRollover'].post
  update:
    x-apievangelist-phrasing:
      intent: Roll over a registered server's certificate
      effect: write
      questions:
      - How do I rotate the certificate a File Sync registered server uses?
      - Can I trigger a certificate rollover for a server registered to a sync service?
      instructions:
      - text: Trigger certificate rollover for registered server {serverId} in {storageSyncServiceName}.
        slots:
          serverId: path.serverId
          storageSyncServiceName: path.storageSyncServiceName
      - text: Roll server {serverId} in sync service {storageSyncServiceName} over to certificate {serverCertificate}.
        slots:
          serverId: path.serverId
          storageSyncServiceName: path.storageSyncServiceName
          serverCertificate: requestBody.serverCertificate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}/abort'].post
  update:
    x-apievangelist-phrasing:
      intent: Abort a storage sync workflow
      effect: destructive
      questions:
      - How do I stop a stuck workflow in my Storage Sync Service?
      - Can I cancel a File Sync workflow that is still running?
      instructions:
      - text: Abort workflow {workflowId} in storage sync service {storageSyncServiceName}.
        slots:
          workflowId: path.workflowId
          storageSyncServiceName: path.storageSyncServiceName
      - text: Cancel the running sync workflow {workflowId} on {storageSyncServiceName}.
        slots:
          workflowId: path.workflowId
          storageSyncServiceName: path.storageSyncServiceName
      method: generated
      generated: '2026-09-26'