swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PolicyFragment API
schemes:
- https
tags:
- name: PolicyFragment
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments
  : get:
      tags:
      - PolicyFragment
      operationId: microsoftAzureWorkspacepolicyfragmentListbyservice
      description: Gets all policy fragments defined within a workspace.
      x-ms-examples:
        ApiManagementListWorkspacePolicyFragments:
          $ref: ./examples/ApiManagementListWorkspacePolicyFragments.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: $filter
        in: query
        required: false
        type: string
        description: '|     Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>'
      - name: $orderby
        in: query
        required: false
        type: string
        description: OData order by query option.
      - $ref: ./apimanagement.json#/parameters/TopQueryParameter
      - $ref: ./apimanagement.json#/parameters/SkipQueryParameter
      responses:
        '200':
          description: Successfully returned an array of policy fragments.
          schema:
            $ref: ./definitions.json#/definitions/PolicyFragmentCollection
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Policyfragments
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}
  : head:
      tags:
      - PolicyFragment
      operationId: microsoftAzureWorkspacepolicyfragmentGetentitytag
      description: Gets the entity state (Etag) version of a policy fragment.
      x-ms-examples:
        ApiManagementHeadWorkspacePolicyFragment:
          $ref: ./examples/ApiManagementHeadWorkspacePolicyFragment.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/IdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The specified policy fragment exists and the current entity state version is present in the ETag header.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Policyfragments Id
    get:
      tags:
      - PolicyFragment
      operationId: microsoftAzureWorkspacepolicyfragmentGet
      description: Gets a policy fragment.
      x-ms-examples:
        ApiManagementGetWorkspacePolicyFragment:
          $ref: ./examples/ApiManagementGetWorkspacePolicyFragment.json
        ApiManagementGetWorkspacePolicyFragmentFormat:
          $ref: ./examples/ApiManagementGetWorkspacePolicyFragmentFormat.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/IdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ./apimanagement.json#/parameters/PolicyFragmentContentFormat
      responses:
        '200':
          description: Successfully returned a policy fragment.
          schema:
            $ref: ./definitions.json#/definitions/PolicyFragmentContract
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Policyfragments Id
    put:
      tags:
      - PolicyFragment
      operationId: microsoftAzureWorkspacepolicyfragmentCreateorupdate
      description: Creates or updates a policy fragment.
      x-ms-examples:
        ApiManagementCreateWorkspacePolicyFragment:
          $ref: ./examples/ApiManagementCreateWorkspacePolicyFragment.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/IdParameter
      - name: parameters
        in: body
        required: true
        schema:
          $ref: ./definitions.json#/definitions/PolicyFragmentContract
        description: The policy fragment contents to apply.
      - $ref: ./apimanagement.json#/parameters/IfMatchOptionalParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The policy fragment was successfully updated.
          schema:
            $ref: ./definitions.json#/definitions/PolicyFragmentContract
          headers:
            ETag:
              description: Current entity state version
              type: string
            location:
              description: Location header contains the URL where the status of the long running operation can be checked
              type: string
            Azure-AsyncOperation:
              description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked
              type: string
        '201':
          description: The policy fragment was successfully created.
          schema:
            $ref: ./definitions.json#/definitions/PolicyFragmentContract
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
            location:
              description: Location header contains the URL where the status of the long running operation can be checked
              type: string
            Azure-AsyncOperation:
              description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Policyfragments Id
    delete:
      tags:
      - PolicyFragment
      operationId: microsoftAzureWorkspacepolicyfragmentDelete
      description: Deletes a policy fragment.
      x-ms-examples:
        ApiManagementDeleteWorkspacePolicyFragment:
          $ref: ./examples/ApiManagementDeleteWorkspacePolicyFragment.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/IdParameter
      - $ref: ./apimanagement.json#/parameters/IfMatchRequiredParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The policy fragment was successfully removed.
        '204':
          description: The policy fragment successfully removed by previous request or does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Policyfragments Id
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}/listReferences
  : post:
      tags:
      - PolicyFragment
      operationId: microsoftAzureWorkspacepolicyfragmentListreferences
      description: Lists policy resources that reference the policy fragment.
      x-ms-examples:
        ApiManagementListWorkspacePolicyFragmentReferences:
          $ref: ./examples/ApiManagementListWorkspacePolicyFragmentReferences.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/IdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ./apimanagement.json#/parameters/TopQueryParameter
      - $ref: ./apimanagement.json#/parameters/SkipQueryParameter
      responses:
        '200':
          description: Successfully returned an array of references to policy resources that include the policy fragment in their definitions.
          schema:
            $ref: ./definitions.json#/definitions/ResourceCollection
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Policyfragments Id Listreferences
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'