swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Global Communications Site API
schemes:
- https
tags:
- name: Global Communications Site
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Orbital/globalCommunicationsSites:
    get:
      tags:
      - Global Communications Site
      description: Returns a list of the global communications sites that a subscription is authorized to use.
      operationId: microsoftAzureGlobalcommunicationssitesListbysubscription
      x-ms-examples:
        List of Global Communications Sites:
          $ref: ./examples/GlobalCommunicationsSitesBySubscriptionList.json
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Request successful. The operation returns a list of global communications sites.
          schema:
            $ref: '#/definitions/GlobalCommunicationsSiteListResult'
        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 Globalcommunicationssites
  /subscriptions/{subscriptionId}/providers/Microsoft.Orbital/globalCommunicationsSites/{globalCommunicationsSiteName}:
    get:
      tags:
      - Global Communications Site
      operationId: microsoftAzureGlobalcommunicationssitesGet
      description: Gets the specified global communications site in a specified resource group.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/globalCommunicationsSiteNameParameter'
      responses:
        '200':
          description: Request successful. The operation returns the resulting GlobalCommunicationsSite.
          schema:
            $ref: '#/definitions/GlobalCommunicationsSite'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Global Communications Site:
          $ref: ./examples/GlobalCommunicationsSiteGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Orbital Globalcommunicationssites Globalcommunicationssitename
definitions:
  GlobalCommunicationsSite:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        allOf:
        - $ref: '#/definitions/GlobalCommunicationsSitesProperties'
        description: The properties bag for this resource.
    allOf:
    - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    description: A site where the Orbital network is connected to a partner network.
  GlobalCommunicationsSiteListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/GlobalCommunicationsSite'
        description: A list of global communications sites.
      nextLink:
        type: string
        description: The URL to get the next set of results.
        readOnly: true
    description: Response for an API service call that lists Global Communications Sites.
  LocationData:
    type: object
    required:
    - city
    - district
    - country
    properties:
      city:
        type: string
        description: The city of the location (e.g., Miami).
      district:
        type: string
        description: For example, the state (e.g., Florida), province (e.g., Ontario), or region (e.g., Tuscany) of the location.
      country:
        type: string
        description: The nation (e.g., United States of America) of the location.
      closestAzureRegion:
        type: string
        description: The name of the closest Azure region, (e.g., westus2).
      extra:
        type: string
        x-nullable: true
        description: Any extra information needed to uniquely identify the location (e.g., zip code).
    description: Describes a location outside of Azure.
  PartnerRouter:
    type: object
    readOnly: true
    properties:
      name:
        type: string
        readOnly: true
        description: The unique name of the partnerRouter.
    description: One of the partner routers within a global communications site.
  GlobalCommunicationsSiteType:
    type: string
    enum:
    - Edge
    - GroundStation
    x-ms-enum:
      name: GlobalCommunicationsSiteType
      modelAsString: true
    description: The type of the global communications site. groundStations can only use sites of type GroundStation, and edgeSites can only use sites of type Edge.
  GlobalCommunicationsSitesProperties:
    type: object
    properties:
      locationData:
        allOf:
        - $ref: '#/definitions/LocationData'
        description: Describes the location of the global communications site.
      globalCommunicationsSiteType:
        type: string
        allOf:
        - $ref: '#/definitions/GlobalCommunicationsSiteType'
        description: The type of the global communications site. EdgeSite or GroundStation.
      partnerRouters:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/PartnerRouter'
        x-ms-identifiers: []
        description: Partner routers connected to this site.
      partnerSiteBandwidth:
        type: integer
        format: int64
        minimum: 0
        readOnly: true
        description: The bandwidth per partner router cross-connection at this global communications site, measured in bits per second.
    description: Properties object for a global communications site.
parameters:
  globalCommunicationsSiteNameParameter:
    name: globalCommunicationsSiteName
    in: path
    description: Global communications Site name.
    required: true
    type: string
    pattern: ^[A-Za-z][A-Za-z0-9-_]+$
    minLength: 2
    maxLength: 64
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'