# 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 CloudEndpoint…
  version: 1.0.0
extends: openapi/microsoft-azure-cloudendpoint-resource-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: 11
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a File Sync cloud endpoint
      effect: read
      questions:
      - How do I see which Azure file share a sync group's cloud endpoint points to?
      - What are the properties of one cloud endpoint in Azure File Sync?
      instructions:
      - text: Get cloud endpoint {cloudEndpointName} in sync group {syncGroupName} of service {storageSyncServiceName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      - text: Show details for cloud endpoint {cloudEndpointName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a File Sync cloud endpoint
      effect: write
      questions:
      - How do I connect an Azure file share to a sync group as a cloud endpoint?
      - Can I add a new cloud endpoint to an existing File Sync group?
      instructions:
      - text: Create cloud endpoint {cloudEndpointName} in sync group {syncGroupName} on {storageSyncServiceName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      - text: Add cloud endpoint {cloudEndpointName} with properties {properties}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a File Sync cloud endpoint
      effect: destructive
      questions:
      - How do I remove a cloud endpoint from a File Sync group?
      - Can I disconnect an Azure file share from sync by deleting its endpoint?
      instructions:
      - text: Delete cloud endpoint {cloudEndpointName} from sync group {syncGroupName} in {storageSyncServiceName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      - text: Remove cloud endpoint {cloudEndpointName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List cloud endpoints in a sync group
      effect: read
      questions:
      - Which cloud endpoints belong to a given File Sync group?
      - How can I enumerate cloud endpoints for one sync group?
      instructions:
      - text: List cloud endpoints in sync group {syncGroupName} of service {storageSyncServiceName}.
        slots:
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      - text: Show every cloud endpoint under sync group {syncGroupName}.
        slots:
          syncGroupName: path.syncGroupName
      method: generated
      generated: '2026-09-26'
- 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 call do I make before backing up a synced Azure file share?
      - How do I signal File Sync that a share backup is about to start?
      instructions:
      - text: Run pre-backup on cloud endpoint {cloudEndpointName} for file share {azureFileShare}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          azureFileShare: requestBody.azureFileShare
      - text: Start pre-backup for endpoint {cloudEndpointName} in sync group {syncGroupName} of {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}/postbackup'].post
  update:
    x-apievangelist-phrasing:
      intent: Finish a cloud endpoint backup
      effect: write
      questions:
      - How do I tell File Sync a share backup has completed?
      - Which step follows a finished backup of a synced file share?
      instructions:
      - text: Run post-backup on cloud endpoint {cloudEndpointName} for file share {azureFileShare}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          azureFileShare: requestBody.azureFileShare
      - text: Complete the backup for endpoint {cloudEndpointName} in sync group {syncGroupName} of {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}/prerestore'].post
  update:
    x-apievangelist-phrasing:
      intent: Prepare a cloud endpoint for a restore
      effect: write
      questions:
      - What must I call before restoring files into a synced Azure file share?
      - Can I give File Sync the source share URI before a restore begins?
      instructions:
      - text: Run pre-restore on endpoint {cloudEndpointName} from source share {sourceAzureFileShareUri}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          sourceAzureFileShareUri: requestBody.sourceAzureFileShareUri
      - text: Prepare cloud endpoint {cloudEndpointName} in sync group {syncGroupName} of {storageSyncServiceName} for a restore.
        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}/restoreheartbeat'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a restore heartbeat for a cloud endpoint
      effect: write
      questions:
      - How do I keep a long File Sync restore alive with a heartbeat?
      - Is there a keep-alive call while restoring a cloud endpoint?
      instructions:
      - text: Send a restore heartbeat for cloud endpoint {cloudEndpointName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
      - text: Ping restore heartbeat on {cloudEndpointName} in sync group {syncGroupName} of {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: Finish a cloud endpoint restore
      effect: write
      questions:
      - How do I report that a File Sync restore finished, including files that failed?
      - What call closes out a restore into a synced share?
      instructions:
      - text: Run post-restore on endpoint {cloudEndpointName} with status {status}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          status: requestBody.status
      - text: Complete the restore for {cloudEndpointName} in sync group {syncGroupName} of {storageSyncServiceName}, listing failed files {failedFileList}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
          failedFileList: requestBody.failedFileList
      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: Detect changes made directly on a synced file share
      effect: write
      questions:
      - I edited files directly in the Azure file share; how do I get File Sync to notice?
      - Can I run change detection on just one directory of a synced share?
      instructions:
      - text: Trigger change detection on cloud endpoint {cloudEndpointName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
      - text: Detect changes under {directoryPath} on endpoint {cloudEndpointName} in sync group {syncGroupName} of {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 the share metadata signing certificate keys
      effect: read
      questions:
      - Where do I get the public keys used to sign File Sync share metadata?
      - How can I verify AFS metadata signatures for a cloud endpoint?
      instructions:
      - text: Get the metadata signing certificate public keys for cloud endpoint {cloudEndpointName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
      - text: Fetch AFS signing keys for {cloudEndpointName} in sync group {syncGroupName} of {storageSyncServiceName}.
        slots:
          cloudEndpointName: path.cloudEndpointName
          syncGroupName: path.syncGroupName
          storageSyncServiceName: path.storageSyncServiceName
      method: generated
      generated: '2026-09-26'