swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SyncGroup Resource API
schemes:
- https
tags:
- name: SyncGroup Resource
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups
  : 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:
      - SyncGroup Resource
      operationId: microsoftAzureSyncgroupsListbystoragesyncservice
      description: Get a SyncGroup List.
      x-ms-examples:
        SyncGroups_ListByStorageSyncService:
          $ref: ./examples/SyncGroups_ListByStorageSyncService.json
      responses:
        '200':
          description: Array of Sync Group resources in Storage Sync Service
          schema:
            $ref: '#/definitions/SyncGroupArray'
          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 Syncgroups
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}
  : 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: parameters
        in: body
        description: Sync Group Body
        required: true
        schema:
          $ref: '#/definitions/SyncGroupCreateParameters'
      tags:
      - SyncGroup Resource
      operationId: microsoftAzureSyncgroupsCreate
      description: Create a new SyncGroup.
      x-ms-examples:
        SyncGroups_Create:
          $ref: ./examples/SyncGroups_Create.json
      responses:
        '200':
          description: Sync Group object
          schema:
            $ref: '#/definitions/SyncGroup'
          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 Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname
    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:
      - SyncGroup Resource
      operationId: microsoftAzureSyncgroupsGet
      description: Get a given SyncGroup.
      x-ms-examples:
        SyncGroups_Get:
          $ref: ./examples/SyncGroups_Get.json
      responses:
        '200':
          description: Sync Group object
          schema:
            $ref: '#/definitions/SyncGroup'
          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
    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
      tags:
      - SyncGroup Resource
      operationId: microsoftAzureSyncgroupsDelete
      description: Delete a given SyncGroup.
      x-ms-examples:
        SyncGroups_Delete:
          $ref: ./examples/SyncGroups_Delete.json
      responses:
        '200':
          description: Sync Group object was deleted
          headers:
            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'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname
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.
  SyncGroupCreateParameters:
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/SyncGroupCreateParametersProperties'
        description: The parameters used to create the sync group
    description: The parameters used when creating a sync group.
  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.
  SyncGroupArray:
    type: object
    description: Array of SyncGroup
    properties:
      value:
        type: array
        description: Collection of SyncGroup.
        items:
          $ref: '#/definitions/SyncGroup'
        x-ms-identifiers:
        - id
  SyncGroup:
    type: object
    description: Sync Group object.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/SyncGroupProperties'
        description: SyncGroup properties.
  SyncGroupCreateParametersProperties:
    type: object
    description: Sync Group Create Properties object.
    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.
  SyncGroupProperties:
    type: object
    description: SyncGroup Properties object.
    properties:
      uniqueId:
        type: string
        description: Unique Id
        readOnly: true
      syncGroupStatus:
        type: string
        description: Sync group status
        readOnly: 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.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'