swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ServerEndpoint Resource API
schemes:
- https
tags:
- name: ServerEndpoint Resource
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}
  : put:
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: storageSyncServiceName
        in: path
        description: Name of Storage Sync Service resource.
        required: true
        type: string
      - name: syncGroupName
        in: path
        description: Name of Sync Group resource.
        required: true
        type: string
      - name: serverEndpointName
        in: path
        description: Name of Server Endpoint object.
        required: true
        type: string
      - name: parameters
        in: body
        description: Body of Server Endpoint object.
        required: true
        schema:
          $ref: '#/definitions/ServerEndpointCreateParameters'
      tags:
      - ServerEndpoint Resource
      operationId: microsoftAzureServerendpointsCreate
      description: Create a new ServerEndpoint.
      x-ms-examples:
        ServerEndpoints_Create:
          $ref: ./examples/ServerEndpoints_Create.json
      responses:
        '200':
          description: Server Endpoint object
          schema:
            $ref: '#/definitions/ServerEndpoint'
          headers:
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        '202':
          description: Asynchronous Operation Status Location
          headers:
            Azure-AsyncOperation:
              description: Operation Status Location URI
              type: string
            Location:
              description: Operation Status Location URI
              type: string
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        default:
          description: Error message indicating why the operation failed.
          schema:
            $ref: '#/definitions/StorageSyncError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Serverendpoints Serverendpointname
    patch:
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: storageSyncServiceName
        in: path
        description: Name of Storage Sync Service resource.
        required: true
        type: string
      - name: syncGroupName
        in: path
        description: Name of Sync Group resource.
        required: true
        type: string
      - name: serverEndpointName
        in: path
        description: Name of Server Endpoint object.
        required: true
        type: string
      - name: parameters
        in: body
        description: Any of the properties applicable in PUT request.
        schema:
          $ref: '#/definitions/ServerEndpointUpdateParameters'
      tags:
      - ServerEndpoint Resource
      operationId: microsoftAzureServerendpointsUpdate
      description: Patch a given ServerEndpoint.
      x-ms-examples:
        ServerEndpoints_Update:
          $ref: ./examples/ServerEndpoints_Update.json
      responses:
        '200':
          description: Server Endpoint object
          schema:
            $ref: '#/definitions/ServerEndpoint'
          headers:
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        '202':
          description: Asynchronous Operation Status Location
          headers:
            Azure-AsyncOperation:
              description: Operation Status Location URI
              type: string
            Location:
              description: Operation Status Location URI
              type: string
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        default:
          description: Error message indicating why the operation failed.
          schema:
            $ref: '#/definitions/StorageSyncError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Serverendpoints Serverendpointname
    get:
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: storageSyncServiceName
        in: path
        description: Name of Storage Sync Service resource.
        required: true
        type: string
      - name: syncGroupName
        in: path
        description: Name of Sync Group resource.
        required: true
        type: string
      - name: serverEndpointName
        in: path
        description: Name of Server Endpoint object.
        required: true
        type: string
      tags:
      - ServerEndpoint Resource
      operationId: microsoftAzureServerendpointsGet
      description: Get a ServerEndpoint.
      x-ms-examples:
        ServerEndpoints_Get:
          $ref: ./examples/ServerEndpoints_Get.json
      responses:
        '200':
          description: Server Endpoint object
          schema:
            $ref: '#/definitions/ServerEndpoint'
          headers:
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        default:
          description: Error message indicating why the operation failed.
          schema:
            $ref: '#/definitions/StorageSyncError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Serverendpoints Serverendpointname
    delete:
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: storageSyncServiceName
        in: path
        description: Name of Storage Sync Service resource.
        required: true
        type: string
      - name: syncGroupName
        in: path
        description: Name of Sync Group resource.
        required: true
        type: string
      - name: serverEndpointName
        in: path
        description: Name of Server Endpoint object.
        required: true
        type: string
      tags:
      - ServerEndpoint Resource
      operationId: microsoftAzureServerendpointsDelete
      description: Delete a given ServerEndpoint.
      x-ms-examples:
        ServerEndpoints_Delete:
          $ref: ./examples/ServerEndpoints_Delete.json
      responses:
        '200':
          description: Ok
          headers:
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        '202':
          description: Asynchronous Operation Status Location
          headers:
            Location:
              description: Operation Status Location URI
              type: string
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        default:
          description: Error message indicating why the operation failed.
          schema:
            $ref: '#/definitions/StorageSyncError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Serverendpoints Serverendpointname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints
  : get:
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: storageSyncServiceName
        in: path
        description: Name of Storage Sync Service resource.
        required: true
        type: string
      - name: syncGroupName
        in: path
        description: Name of Sync Group resource.
        required: true
        type: string
      tags:
      - ServerEndpoint Resource
      operationId: microsoftAzureServerendpointsListbysyncgroup
      description: Get a ServerEndpoint list.
      x-ms-examples:
        ServerEndpoints_ListBySyncGroup:
          $ref: ./examples/ServerEndpoints_ListBySyncGroup.json
      responses:
        '200':
          description: Array of Server Endpoint resources in Sync Group
          schema:
            $ref: '#/definitions/ServerEndpointArray'
          headers:
            Location:
              description: Operation Status Location URI
              type: string
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        default:
          description: Error message indicating why the operation failed.
          schema:
            $ref: '#/definitions/StorageSyncError'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Serverendpoints
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}/recallAction
  : post:
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: storageSyncServiceName
        in: path
        description: Name of Storage Sync Service resource.
        required: true
        type: string
      - name: syncGroupName
        in: path
        description: Name of Sync Group resource.
        required: true
        type: string
      - name: serverEndpointName
        in: path
        description: Name of Server Endpoint object.
        required: true
        type: string
      - name: parameters
        in: body
        description: Body of Recall Action object.
        required: true
        schema:
          $ref: '#/definitions/RecallActionParameters'
      tags:
      - ServerEndpoint Resource
      operationId: microsoftAzureServerendpointsRecallaction
      description: Recall a server endpoint.
      x-ms-examples:
        ServerEndpoints_recallAction:
          $ref: ./examples/ServerEndpoints_Recall.json
      responses:
        '200':
          description: Server Endpoint object
          headers:
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        '202':
          description: Asynchronous Operation Status Location
          headers:
            Location:
              description: Operation Status Location URI
              type: string
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        default:
          description: Error message indicating why the operation failed.
          schema:
            $ref: '#/definitions/StorageSyncError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Serverendpoints Serverendpointname Recallaction
definitions:
  ServerProvisioningStatus:
    type: string
    description: Server provisioning status
    enum:
    - NotStarted
    - InProgress
    - Ready_SyncNotFunctional
    - Ready_SyncFunctional
    - Error
    x-ms-enum:
      name: ServerProvisioningStatus
      modelAsString: true
  ServerEndpointCreateParametersProperties:
    type: object
    description: ServerEndpoint Properties object.
    properties:
      serverLocalPath:
        $ref: '#/definitions/PhysicalPath'
        description: Server Local path.
      cloudTiering:
        $ref: '#/definitions/FeatureStatus'
        description: Cloud Tiering.
      volumeFreeSpacePercent:
        type: integer
        format: int32
        minimum: 0
        maximum: 100
        description: Level of free space to be maintained by Cloud Tiering if it is enabled.
        default: 20
      tierFilesOlderThanDays:
        type: integer
        format: int32
        minimum: 0
        maximum: 2147483647
        description: Tier files older than days.
        default: 0
      friendlyName:
        type: string
        description: Friendly Name
      serverResourceId:
        $ref: '#/definitions/ResourceId'
        description: Server Resource Id.
      offlineDataTransfer:
        $ref: '#/definitions/FeatureStatus'
        description: Offline data transfer
      offlineDataTransferShareName:
        type: string
        description: Offline data transfer share name
      initialDownloadPolicy:
        $ref: '#/definitions/InitialDownloadPolicy'
        description: Policy for how namespace and files are recalled during FastDr.
      localCacheMode:
        $ref: '#/definitions/LocalCacheMode'
        description: 'Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access.'
      initialUploadPolicy:
        $ref: '#/definitions/InitialUploadPolicy'
        description: Policy for how the initial upload sync session is performed.
  ServerEndpointFilesNotSyncingError:
    type: object
    description: Files not syncing error object
    properties:
      errorCode:
        type: integer
        format: int32
        description: Error code (HResult)
        readOnly: true
      persistentCount:
        type: integer
        format: int64
        minimum: 0
        description: Count of persistent files not syncing with the specified error code
        readOnly: true
      transientCount:
        type: integer
        format: int64
        minimum: 0
        description: Count of transient files not syncing with the specified error code
        readOnly: true
  LocalCacheMode:
    type: string
    description: 'Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access.'
    enum:
    - DownloadNewAndModifiedFiles
    - UpdateLocallyCachedFiles
    default: UpdateLocallyCachedFiles
    x-ms-enum:
      name: LocalCacheMode
      modelAsString: true
  ServerEndpointRecallError:
    type: object
    description: Server endpoint recall error object
    properties:
      errorCode:
        type: integer
        format: int32
        description: Error code (HResult)
        readOnly: true
      count:
        type: integer
        format: int64
        minimum: 0
        description: Count of occurences of the error
        readOnly: true
  ServerEndpointHealthState:
    type: string
    description: Type of the server endpoint health state
    enum:
    - Unavailable
    - Healthy
    - Error
    x-ms-enum:
      name: ServerEndpointHealthState
      modelAsString: true
  StorageSyncInnerErrorDetails:
    type: object
    description: Error Details object.
    properties:
      callStack:
        type: string
        description: Call stack of the error.
      message:
        type: string
        description: Error message of the error.
      innerException:
        type: string
        description: Exception of the inner error.
      innerExceptionCallStack:
        type: string
        description: Call stack of the inner error.
  StorageSyncErrorDetails:
    type: object
    description: Error Details object.
    properties:
      code:
        type: string
        description: Error code of the given entry.
      message:
        type: string
        description: Error message of the given entry.
      target:
        type: string
        description: Target of the given entry.
      requestUri:
        type: string
        description: Request URI of the given entry.
      exceptionType:
        type: string
        description: Exception type of the given entry.
      httpMethod:
        type: string
        description: HTTP method of the given entry.
      hashedMessage:
        type: string
        description: Hashed message of the given entry.
      httpErrorCode:
        type: string
        description: HTTP error code of the given entry.
  CloudTieringDatePolicyStatus:
    type: object
    description: Status of the date policy
    properties:
      lastUpdatedTimestamp:
        type: string
        format: date-time
        description: Last updated timestamp
        readOnly: true
      tieredFilesMostRecentAccessTimestamp:
        type: string
        format: date-time
        description: Most recent access time of tiered files
        readOnly: true
  CloudTieringVolumeFreeSpacePolicyStatus:
    type: object
    description: Status of the volume free space policy
    properties:
      lastUpdatedTimestamp:
        type: string
        format: date-time
        description: Last updated timestamp
        readOnly: true
      effectiveVolumeFreeSpacePolicy:
        type: integer
        format: int32
        description: In the case where multiple server endpoints are present in a volume, an effective free space policy is applied.
        readOnly: true
        minimum: 0
        maximum: 100
      currentVolumeFreeSpacePercent:
        type: integer
        format: int32
        description: Current volume free space percentage.
        readOnly: true
        minimum: 0
        maximum: 100
  InitialUploadPolicy:
    type: string
    description: Policy for how the initial upload sync session is performed.
    enum:
    - ServerAuthoritative
    - Merge
    default: Merge
    x-ms-enum:
      name: InitialUploadPolicy
      modelAsString: true
  ServerEndpointArray:
    description: Array of ServerEndpoint
    type: object
    properties:
      value:
        type: array
        description: Collection of ServerEndpoint.
        items:
          $ref: '#/definitions/ServerEndpoint'
        x-ms-identifiers:
        - id
  ServerEndpointCreateParameters:
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ServerEndpointCreateParametersProperties'
        description: The parameters used to create the server endpoint.
    description: The parameters used when creating a server endpoint.
  ServerEndpointProvisioningStatus:
    type: object
    description: Server endpoint provisioning status information
    properties:
      provisioningStatus:
        $ref: '#/definitions/ServerProvisioningStatus'
        description: Server Endpoint provisioning status
        readOnly: true
      provisioningType:
        type: string
        description: Server Endpoint provisioning type
        readOnly: true
      provisioningStepStatuses:
        type: array
        description: Provisioning Step status information for each step in the provisioning process
        items:
          $ref: '#/definitions/ServerEndpointProvisioningStepStatus'
        x-ms-identifiers:
        - name
        readOnly: true
  CloudTieringSpaceSavings:
    type: object
    description: Server endpoint cloud tiering status object.
    properties:
      lastUpdatedTimestamp:
        type: string
        format: date-time
        description: Last updated timestamp
        readOnly: true
      volumeSizeBytes:
        type: integer
        format: int64
        description: Volume size
        readOnly: true
        minimum: 0
      totalSizeCloudBytes:
        type: integer
        format: int64
        description: Total size of content in the azure file share
        readOnly: true
        minimum: 0
      cachedSizeBytes:
        type: integer
        format: int64
        description: Cached content size on the server
        readOnly: true
        minimum: 0
      spaceSavingsPercent:
        type: integer
        format: int32
        description: Percentage of cached size over total size
        readOnly: true
        minimum: 0
        maximum: 100
      spaceSavingsBytes:
        type: integer
        format: int64
        description: Count of bytes saved on the server
        readOnly: true
        minimum: 0
  ServerEndpointSyncActivityStatus:
    type: object
    description: Sync Session status object.
    properties:
      timestamp:
        type: string
        format: date-time
        description: Timestamp when properties were updated
        readOnly: true
      perItemErrorCount:
        type: integer
        format: int64
        minimum: 0
        description: Per item error count
        readOnly: true
      appliedItemCount:
        type: integer
        format: int64
        minimum: 0
        description: Applied item count.
        readOnly: true
      totalItemCount:
        type: integer
        format: int64
        minimum: 0
        description: Total item count (if available)
        readOnly: true
      appliedBytes:
        type: integer
        format: int64
        minimum: 0
        description: Applied bytes
        readOnly: true
      totalBytes:
        type: integer
        format: int64
        minimum: 0
        description: Total bytes (if available)
        readOnly: true
      syncMode:
        $ref: '#/definitions/ServerEndpointSyncMode'
        description: Sync mode
        readOnly: true
      sessionMinutesRemaining:
        type: integer
        format: int32
        minimum: 0
        description: Session minutes remaining (if available)
        readOnly: true
  FilesNotTieringError:
    type: object
    description: Files not tiering error object
    properties:
      errorCode:
        type: integer
        format: int32
        description: Error code (HResult)
        readOnly: true
      fileCount:
        type: integer
        format: int64
        minimum: 0
        description: Count of files with this error
        readOnly: true
  ServerEndpointSyncSessionStatus:
    type: object
    description: Sync Session status object.
    properties:
      lastSyncResult:
        type: integer
        format: int32
        description: Last sync result (HResult)
        readOnly: true
      lastSyncTimestamp:
        type: string
        format: date-time
        description: Last sync timestamp
        readOnly: true
      lastSyncSuccessTimestamp:
        type: string
        format: date-time
        description: Last sync success timestamp
        readOnly: true
      lastSyncPerItemErrorCount:
        type: integer
        format: int64
        minimum: 0
        description: Last sync per item error count.
        readOnly: true
      persistentFilesNotSyncingCount:
        type: integer
        format: int64
        minimum: 0
        description: Count of persistent files not syncing.
        readOnly: true
      transientFilesNotSyncingCount:
        type: integer
        format: int64
        minimum: 0
        description: Count of transient files not syncing.
        readOnly: true
      filesNotSyncingErrors:
        type: array
        items:
          $ref: '#/definitions/ServerEndpointFilesNotSyncingError'
        x-ms-identifiers:
        - errorCode
        description: Array of per-item errors coming from the last sync session.
        readOnly: true
      lastSyncMode:
        $ref: '#/definitions/ServerEndpointSyncMode'
        description: Sync mode
        readOnly: true
  CloudTieringCachePerformance:
    type: object
    description: Server endpoint cloud tiering status object.
    properties:
      lastUpdatedTimestamp:
        type: string
        format: date-time
        description: Last updated timestamp
        readOnly: true
      cacheHitBytes:
        type: integer
        format: int64
        description: Count of bytes that were served from the local server
        readOnly: true
        minimum: 0
      cacheMissBytes:
        type: integer
        format: int64
        description: Count of bytes that were served from the cloud
        readOnly: true
        minimum: 0
      cacheHitBytesPercent:
        type: integer
        format: int32
        description: Percentage of total bytes (hit + miss) that were served from the local server
        readOnly: true
        minimum: 0
        maximum: 100
  ServerEndpointOfflineDataTransferState:
    type: string
    description: Type of the Health state
    enum:
    - InProgress
    - Stopping
    - NotRunning
    - Complete
    x-ms-enum:
      name: ServerEndpointOfflineDataTransferState
      modelAsString: true
  ServerEndpointBackgroundDataDownloadActivity:
    type: object
    description: Background data download activity object
    properties:
      timestamp:
        type: string
        format: date-time
        description: Timestamp when properties were updated
        readOnly: true
      startedTimestamp:
        type: string
        format: date-time
        description: Timestamp when the operation started
        readOnly: true
      percentProgress:
        type: integer
        format: int32
        minimum: 0
        maximum: 100
        description: Progress percentage
        readOnly: true
      downloadedBytes:
        type: integer
        format: int64
        minimum: 0
        description: Running count of bytes downloaded
        readOnly: true
  PhysicalPath:
    type: string
    description: Server folder used for data synchronization
  ServerEndpointRecallStatus:
    type: object
    description: Server endpoint recall status object.
    properties:
      lastUpdatedTimestamp:
        type: string
        format: date-time
        description: Last updated timestamp
        readOnly: true
      totalRecallErrorsCount:
        type: integer
        format: int64
        minimum: 0
        description: Total count of recall errors.
        readOnly: true
      recallErrors:
        type: array
        items:
          $ref: '#/definitions/ServerEndpointRecallError'
        x-ms-identifiers:
        - errorCode
        description: Array of recall errors
        readOnly: true
  CloudTieringFilesNotTiering:
    type: object
    description: Server endpoint cloud tiering status object.
    properties:
      lastUpdatedTimestamp:
        type: string
        format: date-time
        description: Last updated timestamp
        readOnly: true
      totalFileCount:
        type: integer
        format: int64
        description: Last cloud tiering result (HResult)
        readOnly: true
        minimum: 0
      errors:
        type: array
        items:
          $ref: '#/definitions/FilesNotTieringError'
        x-ms-identifiers:
        - errorCode
        description: Array of tiering errors
        readOnly: true
  FeatureStatus:
    type: string
    description: Type of the Feature Status
    enum:
    - 'on'
    - 'off'
    x-ms-enum:
      name: FeatureStatus
      modelAsString: true
  ServerEndpointSyncMode:
    type: string
    description: Sync mode for the server endpoint.
    enum:
    - Regular
    - NamespaceDownload
    - InitialUpload
    - SnapshotUpload
    - InitialFullDownload
    x-ms-enum:
      name: ServerEndpointSyncMode
      modelAsString: true
  ResourceId:
    type: string
    description: Arm resource identifier.
  RecallActionParameters:
    type: object
    properties:
      pattern:
        type: string
        description: Pattern of the files.
      recallPath:
        type: string
        description: Recall path.
    description: The parameters used when calling recall action on server endpoint.
  ServerEndpointProperties:
    type: object
    description: ServerEndpoint Properties object.
    properties:
      serverLocalPath:
        $ref: '#/definitions/PhysicalPath'
        description: Server Local path.
      cloudTiering:
        $ref: '#/definitions/FeatureStatus'
        description: Cloud Tiering.
      volumeFreeSpacePercent:
        type: integer
        format: int32
        minimum: 0
        maximum: 100
        description: Level of free space to be maintained by Cloud Tiering if it is enabled.
      tierFilesOlderThanDays:
        type: integer
        format: int32
        minimum: 0
        maximum: 2147483647
        description: Tier files older than days.
      friendlyName:
        type: string
        description: Friendly Name
      serverResourceId:
        $ref: '#/definitions/ResourceId'
        description: Server Resource Id.
      provisioningState:
        readOnly: true
        type: string
        description: ServerEndpoint Provisioning State
      lastWorkflowId:
        type: string
        description: ServerEndpoint lastWorkflowId
        readOnly: true
      lastOperationName:
        type: string
        description: Resource Last Operation Name
        readOnly: true
      syncStatus:
        $ref: '#/definitions/ServerEndpointSyncStatus'
        description: Server Endpoint sync status
        readOnly: true
      offlineDataTransfer:
        $ref: '#/definitions/FeatureStatus'
        description: Offline data transfer
      offlineDataTransferStorageAccountResourceId:
        type: string
        description: Offline data transfer storage account resource ID
        readOnly: true
      offlineDataTransferStorageAccountTenantId:
        type: string
        description: Offline data transfer storage account tenant ID
        readOnly: true
      offlineDataTransferShareName:
        type: string
        description: Offline data transfer share name
      cloudTieringStatus:
        $ref: '#/definitions/ServerEndpointCloudTieringStatus'
        description: Cloud tiering status. Only populated if cloud tiering is enabled.
        readOnly: true
      recallStatus:
        $ref: '#/definitions/ServerEndpointRecallStatus'
        description: Recall status. Only populated if cloud tiering is enabled.
        readOnly: true
      initialDownloadPolicy:
        $ref: '#/definitions/InitialDownloadPolicy'
        description: Policy for how namespace and files are recalled during FastDr.
      localCacheMode:
        $ref: '#/definitions/LocalCacheMode'
        description: 'Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access.'
      initialUploadPolicy:
        $ref: '#/definitions/InitialUploadPolicy'
        description: Policy for how the initial upload sync session is performed.
      serverName:
        type: string
        description: Server name
        readOnly: true
      serverEndpointProvisioningStatus:
        $ref: '#/definitions/ServerEndpointProvisioningStatus'
        description: Server Endpoint provisioning status
  ServerEndpointUpdateProperties:
    type: object
    description: ServerEndpoint Update Properties object.
    properties:
      cloudTiering:
        $ref: '#/definitions/FeatureStatus'
        description: Cloud Tiering.
      volumeFreeSpacePercent:
        type: integer
        format: int32
        minimum: 0
        maximum: 100
        description: Level of free space to be maintained by Cloud Tiering if it is enabled.
      tierFilesOlderThanDays:
        type: integer
        format: int32
        minimum: 0
        maximum: 2147483647
        description: Tier files older than days.
      offlineDataTransfer:
        $ref: '#/definitions/FeatureStatus'
        description: Offline data transfer
      offlineDataTransferShareName:
        type: string
        description: Offline data transfer share name
      localCacheMode:
        $ref: '#/definitions/LocalCacheMode'
        description: 'Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access.'
  StorageSyncError:
    type: object
    description: Error type
    properties:
      error:
        $ref: '#/definitions/StorageSyncApiError'
        description: Error details of the given entry.
      innererror:
        $ref: '#/definitions/StorageSyncApiError'
        description: Error details of the given entry.
  ServerEndpointSyncActivityState:
    type: string
    description: Type of the sync activity state
    enum:
    - Upload
    - Download
    - UploadAndDownload
    x-ms-enum:
      name: ServerEndpointSyncActivityState
      modelAsString: true
  ServerEndpointSyncStatus:
    type: object
    description: Server Endpoint sync status
    properties:
      downloadHealth:
        $ref: '#/definitions/ServerEndpointHealthState'
        description: Download Health Status.
        readOnly: true
      uploadHealth:
        $ref: '#/definitions/ServerEndpointHealthState'
        description: Upload Health Status.
        readOnly: true
      combinedHealth:
        $ref: '#/definitions/ServerEndpointHealthState'
        description: Combined Health Status.
        readOnly: true
      syncActivity:
        $ref: '#/definitions/ServerEndpointSyncActivityState'
        description: Sync activity
        readOnly: true
      totalPersistentFilesNotSyncingCount:
        type: integer
        format: int64
        minimum: 0
        description: Total count of persistent files not syncing (combined upload + download).
        readOnly: true
      lastUpdatedTimestamp:
        type: string
        format: date-time
        description: Last Updated Timestamp
        readOnly: true
      uploadStatus:
        $ref: '#/definitions/ServerEndpointSyncSessionStatus'
        description: Upload Status
        readOnly: true
      downloadStatus:
        $ref: '#/definitions/ServerEndpointSyncSessionStatus'
        description: Download Status
        readOnly: true
      uploadActivity:
        $ref: '#/definitions/ServerEndpointSyncActivityStatus'
        description: Upload sync activity
        readOnly: true
      downloadActivity:
        $ref: '#/definitions/ServerEndpointSyncActivityStatus'
        description: Download sync activity
        readOnly: true
      offlineDataTransferStatus:
        $ref: '#/definitions/ServerEndpointOfflineDataTransferState'
        description: Offline Data Transfer State
        readOnly: true
      backgroundDataDownloadActivity:
        $ref: '#/definitions/ServerEndpointBackgroundDataDownloadActivity'
        description: Background data download activity
        readOnly: true
  ServerEndpointCloudTieringStatus:
    type: object
    description: Server endpoint cloud tiering status object.
    properties:
      lastUpdatedTimestamp:
        type: string
        format: date-time
        description: Last updated timestamp
        readOnly: true
      health:
        $ref: '#/definitions/ServerEndpointHealthState'
        description: Cloud tiering health state.
        readOnly: true
      healthLastUpdatedTimestamp:
        type: string
        format: date-time
        description: The last updated timestamp of health state
        readOnly: true
      lastCloudTieringResult:
        type: integer
        format: int32
        description: Last cloud tiering result (HResult)
        readOnly: true
      lastSuccessTimestamp:
        type: string
        format: date-time
        description: Last cloud tiering success timestamp
        readOnly: true
      spaceSavings:
        $ref: '#/definitions/CloudTieringSpaceSavings'
        description: Information regarding how much local space cloud tiering is saving.
        readOnly: true
      cachePerformance:
        $ref: '#/definitions/CloudTieringCachePerformance'
        description: Information regarding how well the local cache on the server is performing.
        readOnly: true
      filesNotTiering:
        $ref: '#/definitions/CloudTieringFilesNotTiering'
        description: Information regarding files that failed to be tiered
        readOnly: true
      volumeFreeSpacePolicyStatus:
        $ref: '#/definitions/CloudTieringVolumeFreeSpacePolicyStatus'
        description: Status of the volume free space policy
        readOnly: true
      datePolicyStatus:
        $ref: '#/definitions/CloudTieringDatePolicyStatus'
        description: Status of the date policy
        readOnly: true
      lowDiskMode:
        $ref: '#/definitions/CloudTieringLowDiskMode'
        description: Information regarding the low disk mode state
        readOnly: true
  StorageSyncApiError:
    type: object
    description: Error type
    properties:
      code:
        type: string
        description: Error code of the given entry.
      message:
        type: string
        description: Error message of the given entry.
      target:
        type: string
        description: Target of the given error entry.
      details:
        $ref: '#/definitions/StorageSyncErrorDetails'
        description: Error details of the given entry.
      innererror:
        $ref: '#/definitions/StorageSyncInnerErrorDetails'
        description: Inner error details of the given entry.
  InitialDownloadPolicy:
    type: string
    description: Policy for how namespace and files are recalled during FastDr
    enum:
    - NamespaceOnly
    - NamespaceThenModifiedFiles
    - AvoidTieredFiles
    default: NamespaceThenModifiedFiles
    x-ms-enum:
      name: InitialDownloadPolicy
      modelAsString: true
  ServerEndpointProvisioningStepStatus:
    type: object
    description: Server endpoint provisioning step status object.
    properties:
      name:
        type: string
        description: Name of the provisioning step
        readOnly: true
      status:
        type: string
        description: Status of the provisioning step
        readOnly: true
      startTime:
        type: string
        format: date-time
        description: Start time of the provisioning step
        readOnly: true
      minutesLeft:
        type: integer
        format: int32
        description: Estimated completion time of the provisioning step in minutes
        readOnly: true
      progressPercentage:
        type: integer
        format: int32
        description: Estimated progress percentage
        readOnly: true
      endTime:
        type: string
        format: date-time
        description: End time of the provisioning step
        readOnly: true
      errorCode:
        type: integer
        format: int32
        description: Error code (HResult) for the provisioning step
        readOnly: true
      additionalInformation:
        type: object
        additionalProperties:
          type: string
        description: Additional information for the provisioning step
        readOnly: true
  CloudTieringLowDiskModeState:
    type: string
    description: Type of the cloud tiering low disk mode state
    enum:
    - Enabled
    - Disabled
    x-ms-enum:
      name: CloudTieringLowDiskModeState
      modelAsString: true
  ServerEndpointUpdateParameters:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ServerEndpointUpdateProperties'
        description: The properties of the server endpoint.
    description: Parameters for updating an Server Endpoint.
  ServerEndpoint:
    type: object
    description: Server Endpoint object.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ServerEndpointProperties'
        description: Server Endpoint properties.
  CloudTieringLowDiskMode:
    type: object
    description: Information regarding the low disk mode state
    properties:
      lastUpdatedTimestamp:
        type: string
        format: date-time
        description: Last updated timestamp
        readOnly: true
      state:
        $ref: '#/definitions/CloudTieringLowDiskModeState'
        description: Low disk mode state
        readOnly: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'