swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Ground Station API
schemes:
- https
tags:
- name: Ground Station
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Orbital/groundStations:
    get:
      tags:
      - Ground Station
      description: Return list of ground stations.
      operationId: microsoftAzureGroundstationsListbysubscription
      x-ms-examples:
        List of Ground Stations by Subscription:
          $ref: ./examples/GroundStationsBySubscription.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 Ground Station resources.
          schema:
            $ref: '#/definitions/GroundStationListResult'
        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 Groundstations
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/groundStations:
    get:
      tags:
      - Ground Station
      description: Return list of ground stations.
      operationId: microsoftAzureGroundstationsList
      x-ms-examples:
        List of Ground Stations:
          $ref: ./examples/GroundStationsList.json
      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
      - $ref: '#/parameters/skipTokenParameter'
      responses:
        '200':
          description: Request successful. The operation returns a list of Ground Station resources.
          schema:
            $ref: '#/definitions/GroundStationListResult'
        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 Groundstations
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/groundStations/{groundStationName}
  : get:
      tags:
      - Ground Station
      operationId: microsoftAzureGroundstationsGet
      description: Gets the specified ground station 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/ResourceGroupNameParameter
      - $ref: '#/parameters/groundStationNameParameter'
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Request successful. The operation returns the resulting ground station resource.
          schema:
            $ref: '#/definitions/GroundStation'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get GroundStation:
          $ref: ./examples/GroundStationGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Orbital Groundstations Groundstationname
    put:
      tags:
      - Ground Station
      description: Creates or updates a ground station resource.
      operationId: microsoftAzureGroundstationsCreateorupdate
      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
      - $ref: '#/parameters/groundStationNameParameter'
      - name: parameters
        in: body
        required: true
        x-ms-client-flatten: true
        schema:
          $ref: '#/definitions/GroundStation'
        description: The parameters to provide for the created ground station.
      responses:
        '200':
          description: Update successful. The operation returns the resulting ground station resource.
          schema:
            $ref: '#/definitions/GroundStation'
        '201':
          description: Create successful. The operation returns the resulting ground station resource.
          schema:
            $ref: '#/definitions/GroundStation'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create a ground station:
          $ref: ./examples/GroundStationCreate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Orbital Groundstations Groundstationname
    patch:
      tags:
      - Ground Station
      operationId: microsoftAzureGroundstationsUpdatetags
      x-ms-examples:
        Update Ground Station tags:
          $ref: ./examples/GroundStationUpdateTags.json
      description: Updates the specified ground station 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 ground station tags.
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/groundStationNameParameter'
      responses:
        '200':
          description: Update successful. The operation returns the resulting Ground Station resource.
          schema:
            $ref: '#/definitions/GroundStation'
        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 Groundstations Groundstationname
    delete:
      tags:
      - Ground Station
      operationId: microsoftAzureGroundstationsDelete
      description: Deletes a specified ground station resource.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/groundStationNameParameter'
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      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 Ground Station:
          $ref: ./examples/GroundStationDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Orbital Groundstations Groundstationname
definitions:
  TagsObject:
    type: object
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags.
    description: Tags object for patch operations.
  GroundStationListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/GroundStation'
        description: A list of ground station resources.
      nextLink:
        type: string
        description: The URL to get the next set of results.
        readOnly: true
    description: Response for the ListGroundStations API service call.
  GroundStation:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        allOf:
        - $ref: '#/definitions/GroundStationsProperties'
        description: Properties of the Ground Station.
    allOf:
    - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
    description: Ground Station contains one or more antennas.
  Capability:
    type: string
    description: Capability of the Ground Station.
    enum:
    - EarthObservation
    - Communication
    x-ms-enum:
      name: Capability
      modelAsString: true
  GroundStationsProperties:
    type: object
    required:
    - capabilities
    - globalCommunicationsSite
    properties:
      city:
        type: string
        description: City of ground station.
      capabilities:
        type: array
        items:
          $ref: '#/definitions/Capability'
        description: Ground station capabilities.
      providerName:
        type: string
        description: Ground station provider name.
      longitudeDegrees:
        type: number
        description: Longitude of the ground station in decimal degrees.
      latitudeDegrees:
        type: number
        description: Latitude of the ground station in decimal degrees.
      altitudeMeters:
        type: number
        description: Altitude of the ground station.
      releaseMode:
        type: string
        enum:
        - Preview
        - GA
        x-ms-enum:
          name: releaseMode
          modelAsString: true
        readOnly: true
        description: Release Status of a ground station.
      globalCommunicationsSite:
        allOf:
        - $ref: '#/definitions/ResourceReference'
        description: A reference to global communications site.
    description: List of ground station resource properties.
  ResourceReference:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: Resource ID.
    description: Resource Reference.
parameters:
  groundStationNameParameter:
    name: groundStationName
    in: path
    required: true
    type: string
    description: Ground Station name.
    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'