swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector FluidRelayServers API
schemes:
- https
tags:
- name: FluidRelayServers
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.FluidRelay/fluidRelayServers/{fluidRelayServerName}
  : get:
      operationId: microsoftAzureFluidrelayserversGet
      tags:
      - FluidRelayServers
      summary: Microsoft Azure Get A Fluid Relay Server
      x-ms-examples:
        Get Fluid Relay server details:
          $ref: ./examples/FluidRelayServers_Get.json
      parameters:
      - $ref: '#/parameters/SubscriptionId'
      - $ref: '#/parameters/ResourceGroup'
      - $ref: '#/parameters/FluidRelayServerName'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          schema:
            $ref: '#/definitions/FluidRelayServer'
          description: Request completed synchronously.
        default:
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
          description: Error in operation.
      description: Needs a more full description created.
    put:
      operationId: microsoftAzureFluidrelayserversCreateorupdate
      tags:
      - FluidRelayServers
      summary: Microsoft Azure Create Or Update A Fluid Relay Server
      x-ms-examples:
        Create a Fluid Relay server:
          $ref: ./examples/FluidRelayServers_CreateOrUpdate.json
      parameters:
      - $ref: '#/parameters/SubscriptionId'
      - $ref: '#/parameters/ResourceGroup'
      - $ref: '#/parameters/FluidRelayServerName'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: resource
        in: body
        required: true
        schema:
          $ref: '#/definitions/FluidRelayServer'
        description: The details of the Fluid Relay server resource.
      responses:
        '200':
          schema:
            $ref: '#/definitions/FluidRelayServer'
          description: Request completed synchronously.
        default:
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
          description: Error in operation.
      description: Needs a more full description created.
    patch:
      operationId: microsoftAzureFluidrelayserversUpdate
      tags:
      - FluidRelayServers
      summary: Microsoft Azure Update A Fluid Relay Server
      x-ms-examples:
        Update a Fluid Relay server:
          $ref: ./examples/FluidRelayServers_Update.json
      parameters:
      - $ref: '#/parameters/SubscriptionId'
      - $ref: '#/parameters/ResourceGroup'
      - $ref: '#/parameters/FluidRelayServerName'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: resource
        in: body
        required: true
        schema:
          $ref: '#/definitions/FluidRelayServerUpdate'
        description: The updatable details of the Fluid Relay server resource.
      responses:
        '200':
          schema:
            $ref: '#/definitions/FluidRelayServer'
          description: Request Completed Synchronously.
        default:
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
          description: Error in operation.
      description: Needs a more full description created.
    delete:
      operationId: microsoftAzureFluidrelayserversDelete
      tags:
      - FluidRelayServers
      summary: Microsoft Azure Delete A Fluid Relay Server
      x-ms-examples:
        Delete a Fluid Relay server:
          $ref: ./examples/FluidRelayServers_Delete.json
      parameters:
      - $ref: '#/parameters/SubscriptionId'
      - $ref: '#/parameters/ResourceGroup'
      - $ref: '#/parameters/FluidRelayServerName'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Request completed Synchronously.
        '204':
          description: Request completed Synchronously.
        default:
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
          description: Error in operation.
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.FluidRelay/fluidRelayServers/{fluidRelayServerName}/regenerateKey
  : post:
      operationId: microsoftAzureFluidrelayserversRegeneratekey
      summary: Microsoft Azure Regenerate The Primary Or Secondary Key For This Server
      x-ms-examples:
        Regenerate keys for a Fluid Relay server:
          $ref: ./examples/FluidRelayServers_RegenerateKeys.json
      tags:
      - FluidRelayServers
      parameters:
      - $ref: '#/parameters/SubscriptionId'
      - $ref: '#/parameters/ResourceGroup'
      - $ref: '#/parameters/FluidRelayServerName'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/RegenerateKeyRequest'
        description: The details of which keys to generate.
      responses:
        '200':
          schema:
            $ref: '#/definitions/FluidRelayServerKeys'
          description: Request Completed Synchronously.
        default:
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
          description: Error in operation.
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.FluidRelay/fluidRelayServers/{fluidRelayServerName}/getKeys
  : post:
      operationId: microsoftAzureFluidrelayserversGetkeys
      summary: Microsoft Azure Regenerate The Primary Or Secondary Key For This Server
      x-ms-examples:
        Get keys for a Fluid Relay server:
          $ref: ./examples/FluidRelayServers_GetKeys.json
      tags:
      - FluidRelayServers
      parameters:
      - $ref: '#/parameters/SubscriptionId'
      - $ref: '#/parameters/ResourceGroup'
      - $ref: '#/parameters/FluidRelayServerName'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          schema:
            $ref: '#/definitions/FluidRelayServerKeys'
          description: Request Completed Synchronously.
        default:
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
          description: Error in operation.
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/providers/Microsoft.FluidRelay/fluidRelayServers:
    get:
      operationId: microsoftAzureFluidrelayserversListbysubscription
      summary: Microsoft Azure List All Fluid Relay Servers In A Subscription
      x-ms-examples:
        List all Fluid Relay servers in a subscription:
          $ref: ./examples/FluidRelayServers_ListBySubscription.json
      tags:
      - FluidRelayServers
      parameters:
      - $ref: '#/parameters/SubscriptionId'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          schema:
            $ref: '#/definitions/FluidRelayServerList'
          description: Paged response
        default:
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
          description: Error in operation.
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.FluidRelay/fluidRelayServers:
    get:
      operationId: microsoftAzureFluidrelayserversListbyresourcegroup
      tags:
      - FluidRelayServers
      summary: Microsoft Azure List All Fluid Relay Servers In A Resource Group
      x-ms-examples:
        List all Fluid Relay servers in a resource group:
          $ref: ./examples/FluidRelayServers_ListByResourceGroup.json
      parameters:
      - $ref: '#/parameters/SubscriptionId'
      - $ref: '#/parameters/ResourceGroup'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          schema:
            $ref: '#/definitions/FluidRelayServerList'
          description: Paged response
        default:
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
          description: Error in operation.
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
definitions:
  FluidRelayServerKeys:
    type: object
    properties:
      key1:
        type: string
        format: password
        description: The primary key for this server
        readOnly: true
      key2:
        type: string
        format: password
        description: The secondary key for this server
        readOnly: true
    description: The set of available keys for this server.
  Identity:
    description: Identity for the resource.
    type: object
    properties:
      principalId:
        readOnly: true
        type: string
        description: The principal ID of resource identity.
      tenantId:
        readOnly: true
        type: string
        description: The tenant ID of resource.
      type:
        enum:
        - SystemAssigned
        - None
        x-ms-enum:
          name: ResourceIdentityType
          modelAsString: true
        type: string
        description: The identity type.
  FluidRelayServer:
    type: object
    properties:
      properties:
        $ref: '#/definitions/FluidRelayServerProperties'
        description: The resource-specific properties for this resource.
        readOnly: false
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: System meta data for this resource, including creation and modification information.
        readOnly: true
      identity:
        $ref: '#/definitions/Identity'
        description: The type of identity used for the resource.
    description: A FluidRelay Server.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource
  FluidRelayEndpoints:
    type: object
    properties:
      ordererEndpoints:
        type: array
        items:
          type: string
        description: The Fluid Relay Orderer endpoints.
        readOnly: true
      storageEndpoints:
        type: array
        items:
          type: string
        description: The Fluid Relay storage endpoints.
        readOnly: true
    description: The Fluid Relay endpoints for this server
  RegenerateKeyRequest:
    type: object
    properties:
      keyName:
        type: string
        enum:
        - key1
        - key2
        x-ms-enum:
          modelAsString: false
          name: KeyName
        x-adl-name: key1 | key2
        description: The key to regenerate.
    description: Specifies which key should be generated.
    required:
    - keyName
  FluidRelayServerList:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/FluidRelayServer'
        description: A sequence of FluidRelay servers.
        x-adl-name: FluidRelayServer[]
      nextLink:
        type: string
        description: A link to the next page of results, if any.
    description: Paged response
    required:
    - value
    x-adl-name: Page<FluidRelayServer>
  FluidRelayServerProperties:
    type: object
    properties:
      frsTenantId:
        type: string
        description: The Fluid tenantId for this server
        readOnly: true
      fluidRelayEndpoints:
        $ref: '#/definitions/FluidRelayEndpoints'
        description: The Fluid Relay Service endpoints for this server.
        readOnly: true
      provisioningState:
        enum:
        - Succeeded
        - Failed
        - Canceled
        type: string
        description: Provision states for FluidRelay RP
        title: ProvisioningState
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
    description: The properties of a Fluid Relay Service resource.
  FluidRelayServerUpdate:
    type: object
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        readOnly: false
        x-ms-mutability:
        - read
        - create
        - update
        description: Resource tags.
      identity:
        $ref: '#/definitions/Identity'
        description: The type of identity used for the resource.
    description: The updatable properties of a Fluid Relay server
parameters:
  FluidRelayServerName:
    name: fluidRelayServerName
    in: path
    type: string
    required: true
    description: The Fluid Relay server resource name.
    x-ms-parameter-location: method
  ResourceGroup:
    name: resourceGroup
    in: path
    type: string
    required: true
    description: The resource group containing the resource.
    x-ms-parameter-location: method
  SubscriptionId:
    name: subscriptionId
    in: path
    type: string
    required: true
    description: The subscription id (GUID) for this resource.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'