swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector RegisteredServer Resource API
schemes:
- https
tags:
- name: RegisteredServer Resource
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers
  : 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
      tags:
      - RegisteredServer Resource
      operationId: microsoftAzureRegisteredserversListbystoragesyncservice
      description: Get a given registered server list.
      x-ms-examples:
        RegisteredServers_ListByStorageSyncService:
          $ref: ./examples/RegisteredServers_ListByStorageSyncService.json
      responses:
        '200':
          description: Array of Registered Server resources in Storage Sync Service
          schema:
            $ref: '#/definitions/RegisteredServerArray'
          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'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Registeredservers
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}
  : 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: serverId
        in: path
        description: GUID identifying the on-premises server.
        required: true
        type: string
      tags:
      - RegisteredServer Resource
      operationId: microsoftAzureRegisteredserversGet
      description: Get a given registered server.
      x-ms-examples:
        RegisteredServers_Get:
          $ref: ./examples/RegisteredServers_Get.json
      responses:
        '200':
          description: Registered Server resources in Sync Group
          schema:
            $ref: '#/definitions/RegisteredServer'
          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 Registeredservers Serverid
    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: serverId
        in: path
        description: GUID identifying the on-premises server.
        required: true
        type: string
      - name: parameters
        in: body
        description: Body of Registered Server object.
        required: true
        schema:
          $ref: '#/definitions/RegisteredServerCreateParameters'
      tags:
      - RegisteredServer Resource
      operationId: microsoftAzureRegisteredserversCreate
      description: Add a new registered server.
      x-ms-examples:
        RegisteredServers_Create:
          $ref: ./examples/RegisteredServers_Create.json
      responses:
        '200':
          description: Registered Server resources in Sync Group
          schema:
            $ref: '#/definitions/RegisteredServer'
          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 Registeredservers Serverid
    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: serverId
        in: path
        description: GUID identifying the on-premises server.
        required: true
        type: string
      - name: parameters
        in: body
        description: Body of Registered Server object.
        required: true
        schema:
          $ref: '#/definitions/RegisteredServerUpdateParameters'
      tags:
      - RegisteredServer Resource
      operationId: microsoftAzureRegisteredserversUpdate
      description: Update registered server.
      x-ms-examples:
        RegisteredServers_Update:
          $ref: ./examples/RegisteredServers_Update.json
      responses:
        '200':
          description: Registered Server resources in Sync Group
          schema:
            $ref: '#/definitions/RegisteredServer'
          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: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Registeredservers Serverid
    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: serverId
        in: path
        description: GUID identifying the on-premises server.
        required: true
        type: string
      tags:
      - RegisteredServer Resource
      operationId: microsoftAzureRegisteredserversDelete
      description: Delete the given registered server.
      x-ms-examples:
        RegisteredServers_Delete:
          $ref: ./examples/RegisteredServers_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
        '204':
          description: Resource doesn't exist
        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 Registeredservers Serverid
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}/triggerRollover
  : 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: serverId
        in: path
        description: Server Id
        required: true
        type: string
      - name: parameters
        in: body
        description: Body of Trigger Rollover request.
        required: true
        schema:
          $ref: '#/definitions/TriggerRolloverRequest'
      tags:
      - RegisteredServer Resource
      operationId: microsoftAzureRegisteredserversTriggerrollover
      description: Triggers Server certificate rollover.
      x-ms-examples:
        RegisteredServers_triggerRollover:
          $ref: ./examples/RegisteredServers_TriggerRollover.json
      responses:
        '200':
          description: Trigger Rollover success status
          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 Registeredservers Serverid Triggerrollover
definitions:
  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.
  ServerAuthType:
    type: string
    description: Type of the Server Auth type
    enum:
    - Certificate
    - ManagedIdentity
    x-ms-enum:
      name: ServerAuthType
      modelAsString: true
  RegisteredServerAgentVersionStatus:
    type: string
    description: Type of the registered server agent version status
    enum:
    - Ok
    - NearExpiry
    - Expired
    - Blocked
    x-ms-enum:
      name: RegisteredServerAgentVersionStatus
      modelAsString: true
  RegisteredServerUpdateParameters:
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/RegisteredServerUpdateProperties'
        description: The parameters used to update the registered server.
    description: The parameters used when updating a registered server.
  TriggerRolloverRequest:
    type: object
    description: Trigger Rollover Request.
    properties:
      serverCertificate:
        type: string
        description: Certificate Data
  RegisteredServerArray:
    description: Array of RegisteredServer
    type: object
    properties:
      value:
        type: array
        description: Collection of Registered Server.
        items:
          $ref: '#/definitions/RegisteredServer'
        x-ms-identifiers:
        - id
  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.
  RegisteredServerProperties:
    type: object
    description: RegisteredServer Properties object.
    properties:
      serverCertificate:
        type: string
        description: Registered Server Certificate
      agentVersion:
        type: string
        description: Registered Server Agent Version
      agentVersionStatus:
        $ref: '#/definitions/RegisteredServerAgentVersionStatus'
        description: Registered Server Agent Version Status
        readOnly: true
      agentVersionExpirationDate:
        type: string
        format: date-time
        description: Registered Server Agent Version Expiration Date
        readOnly: true
      serverOSVersion:
        type: string
        description: Registered Server OS Version
      serverManagementErrorCode:
        type: integer
        format: int32
        description: Registered Server Management Error Code
      lastHeartBeat:
        type: string
        description: Registered Server last heart beat
      provisioningState:
        type: string
        description: Registered Server Provisioning State
      serverRole:
        type: string
        description: Registered Server serverRole
      clusterId:
        type: string
        description: Registered Server clusterId
      clusterName:
        type: string
        description: Registered Server clusterName
      serverId:
        type: string
        description: Registered Server serverId
      storageSyncServiceUid:
        type: string
        description: Registered Server storageSyncServiceUid
      lastWorkflowId:
        type: string
        description: Registered Server lastWorkflowId
      lastOperationName:
        type: string
        description: Resource Last Operation Name
      discoveryEndpointUri:
        type: string
        description: Resource discoveryEndpointUri
      resourceLocation:
        type: string
        description: Resource Location
      serviceLocation:
        type: string
        description: Service Location
      friendlyName:
        type: string
        description: Friendly Name
      managementEndpointUri:
        type: string
        description: Management Endpoint Uri
      monitoringEndpointUri:
        type: string
        description: Telemetry Endpoint Uri
      monitoringConfiguration:
        type: string
        description: Monitoring Configuration
      serverName:
        type: string
        description: Server name
        readOnly: true
      applicationId:
        type: string
        description: Server Application Id
      identity:
        type: boolean
        description: Apply server with newly discovered ApplicationId if available.
        readOnly: true
      latestApplicationId:
        type: string
        description: Latest Server Application Id discovered from the server. It is not yet applied.
      activeAuthType:
        $ref: '#/definitions/ServerAuthType'
        description: Server auth type.
        readOnly: true
  RegisteredServerUpdateProperties:
    type: object
    description: RegisteredServer Update Properties object.
    properties:
      identity:
        type: boolean
        description: Apply server with newly discovered ApplicationId if available.
  RegisteredServer:
    type: object
    description: Registered Server resource.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/RegisteredServerProperties'
        description: RegisteredServer properties.
  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.
  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.
  RegisteredServerCreateParametersProperties:
    type: object
    description: RegisteredServer Create Properties object.
    properties:
      serverCertificate:
        type: string
        description: Registered Server Certificate
      agentVersion:
        type: string
        description: Registered Server Agent Version
      serverOSVersion:
        type: string
        description: Registered Server OS Version
      lastHeartBeat:
        type: string
        description: Registered Server last heart beat
      serverRole:
        type: string
        description: Registered Server serverRole
      clusterId:
        type: string
        description: Registered Server clusterId
      clusterName:
        type: string
        description: Registered Server clusterName
      serverId:
        type: string
        description: Registered Server serverId
      friendlyName:
        type: string
        description: Friendly Name
      applicationId:
        type: string
        description: Server ServicePrincipal Id
      identity:
        type: boolean
        description: Apply server with newly discovered ApplicationId if available.
  RegisteredServerCreateParameters:
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/RegisteredServerCreateParametersProperties'
        description: The parameters used to create the registered server.
    description: The parameters used when creating a registered server.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'