swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Edge Site API
schemes:
- https
tags:
- name: Edge Site
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/edgeSites/{edgeSiteName}:
    get:
      tags:
      - Edge Site
      operationId: microsoftAzureEdgesitesGet
      description: Gets the specified edge site in a specified resource group.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/edgeSiteNameParameter'
      responses:
        '200':
          description: Request successful. The operation returns the resulting EdgeSite resource.
          schema:
            $ref: '#/definitions/EdgeSite'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Edge Site:
          $ref: ./examples/EdgeSiteGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Orbital Edgesites Edgesitename
    put:
      tags:
      - Edge Site
      description: Creates or updates an edge site.
      operationId: microsoftAzureEdgesitesCreateorupdate
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/edgeSiteNameParameter'
      - name: parameters
        in: body
        required: true
        x-ms-client-flatten: true
        schema:
          $ref: '#/definitions/EdgeSite'
        description: The parameters to provide for the created Edge Site.
      responses:
        '200':
          description: Update successful. The operation returns the resulting EdgeSite resource.
          schema:
            $ref: '#/definitions/EdgeSite'
        '201':
          description: Create successful. The operation returns the resulting EdgeSite resource.
          schema:
            $ref: '#/definitions/EdgeSite'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create Edge Site:
          $ref: ./examples/EdgeSiteCreate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Orbital Edgesites Edgesitename
    delete:
      tags:
      - Edge Site
      operationId: microsoftAzureEdgesitesDelete
      description: Deletes a specified edge site resource.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/edgeSiteNameParameter'
      responses:
        '200':
          description: Delete successful.
        '204':
          description: Request successful. Resource does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete Edge Site:
          $ref: ./examples/EdgeSiteDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Orbital Edgesites Edgesitename
    patch:
      tags:
      - Edge Site
      operationId: microsoftAzureEdgesitesUpdatetags
      x-ms-examples:
        Update Edge Site tags:
          $ref: ./examples/EdgeSiteUpdateTag.json
      description: Updates the specified edge site's tags.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/TagsObject'
        description: Parameters supplied to update the edge site's tags.
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/edgeSiteNameParameter'
      responses:
        '200':
          description: Update successful. The operation returns the resulting Edge Site resource.
          schema:
            $ref: '#/definitions/EdgeSite'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Orbital Edgesites Edgesitename
  /subscriptions/{subscriptionId}/providers/Microsoft.Orbital/edgeSites:
    get:
      tags:
      - Edge Site
      description: Returns a list of edge sites for a subscription.
      operationId: microsoftAzureEdgesitesListbysubscription
      x-ms-examples:
        List of Edge Sites by Subscription:
          $ref: ./examples/EdgeSitesBySubscriptionList.json
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/skipTokenParameter'
      responses:
        '200':
          description: Request successful. The operation returns a list of edge site resources.
          schema:
            $ref: '#/definitions/EdgeSiteListResult'
        default:
          description: Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Orbital Edgesites
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/edgeSites:
    get:
      tags:
      - Edge Site
      description: Returns a list of edge sites for a resource group.
      operationId: microsoftAzureEdgesitesList
      x-ms-examples:
        List of Edge Sites by Resource Group:
          $ref: ./examples/EdgeSitesByResourceGroupList.json
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/skipTokenParameter'
      responses:
        '200':
          description: Request successful. The operation returns a list of edge site resources.
          schema:
            $ref: '#/definitions/EdgeSiteListResult'
        default:
          description: Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Orbital Edgesites
definitions:
  EdgeSiteListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/EdgeSite'
        description: A list of edge site resources.
      nextLink:
        type: string
        description: The URL to get the next set of results.
        readOnly: true
    description: Response for an API service call that lists Edge Sites.
  TagsObject:
    type: object
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags.
    description: Tags object for patch operations.
  EdgeSite:
    type: object
    required:
    - properties
    properties:
      properties:
        x-ms-client-flatten: true
        allOf:
        - $ref: '#/definitions/EdgeSitesProperties'
        description: The properties bag for this resource.
    allOf:
    - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
    description: A customer's reference to a global communications site site.
  EdgeSitesProperties:
    type: object
    required:
    - globalCommunicationsSite
    properties:
      globalCommunicationsSite:
        allOf:
        - $ref: '#/definitions/ResourceReference'
        description: A reference to global communications site.
    description: Properties object for an edge site.
  ResourceReference:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: Resource ID.
    description: Resource Reference.
parameters:
  edgeSiteNameParameter:
    name: edgeSiteName
    in: path
    description: Edge site name.
    required: true
    type: string
    pattern: ^[A-Za-z][A-Za-z0-9-_]+$
    minLength: 2
    maxLength: 64
    x-ms-parameter-location: method
  skipTokenParameter:
    name: $skiptoken
    description: An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous list operation call returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.
    in: query
    required: false
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'