swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PeeringServicePrefixes API
schemes:
- https
tags:
- name: PeeringServicePrefixes
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes/{prefixName}
  : get:
      tags:
      - PeeringServicePrefixes
      description: Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
      operationId: microsoftAzurePrefixesGet
      parameters:
      - name: resourceGroupName
        in: path
        description: The name of the resource group.
        required: true
        type: string
      - name: peeringServiceName
        in: path
        description: The name of the peering service.
        required: true
        type: string
      - name: prefixName
        in: path
        description: The name of the prefix.
        required: true
        type: string
      - name: $expand
        in: query
        description: The properties to be expanded.
        required: false
        type: string
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PeeringServicePrefix'
        default:
          description: Error response describing why the operation has failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Get a prefix associated with the peering service:
          $ref: ./examples/GetPeeringServicePrefix.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Peering Peeringservices Peeringservicename Prefixes Prefixname
    put:
      tags:
      - PeeringServicePrefixes
      description: Creates a new prefix with the specified name under the given subscription, resource group and peering service.
      operationId: microsoftAzurePrefixesCreateorupdate
      parameters:
      - name: resourceGroupName
        in: path
        description: The name of the resource group.
        required: true
        type: string
      - name: peeringServiceName
        in: path
        description: The name of the peering service.
        required: true
        type: string
      - name: prefixName
        in: path
        description: The name of the prefix.
        required: true
        type: string
      - name: peeringServicePrefix
        in: body
        description: The properties needed to create a prefix.
        required: true
        schema:
          $ref: '#/definitions/PeeringServicePrefix'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PeeringServicePrefix'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/PeeringServicePrefix'
        default:
          description: Error response describing why the operation has failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Create or update a prefix for the peering service:
          $ref: ./examples/CreatePeeringServicePrefix.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Peering Peeringservices Peeringservicename Prefixes Prefixname
    delete:
      tags:
      - PeeringServicePrefixes
      description: Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.
      operationId: microsoftAzurePrefixesDelete
      parameters:
      - name: resourceGroupName
        in: path
        description: The name of the resource group.
        required: true
        type: string
      - name: peeringServiceName
        in: path
        description: The name of the peering service.
        required: true
        type: string
      - name: prefixName
        in: path
        description: The name of the prefix.
        required: true
        type: string
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '204':
          description: NoContent
        default:
          description: Error response describing why the operation has failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Delete a prefix associated with the peering service:
          $ref: ./examples/DeletePeeringServicePrefix.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Peering Peeringservices Peeringservicename Prefixes Prefixname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes
  : get:
      tags:
      - PeeringServicePrefixes
      description: Lists all prefixes under the given subscription, resource group and peering service.
      operationId: microsoftAzurePrefixesListbypeeringservice
      parameters:
      - name: resourceGroupName
        in: path
        description: The name of the resource group.
        required: true
        type: string
      - name: peeringServiceName
        in: path
        description: The name of the peering service.
        required: true
        type: string
      - name: $expand
        in: query
        description: The properties to be expanded.
        required: false
        type: string
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PeeringServicePrefixListResult'
        default:
          description: Error response describing why the operation has failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        List all the prefixes associated with the peering service:
          $ref: ./examples/ListPrefixesByPeeringService.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Peering Peeringservices Peeringservicename Prefixes
definitions:
  PeeringServicePrefixProperties:
    description: The peering service prefix properties class.
    type: object
    properties:
      prefix:
        description: The prefix from which your traffic originates.
        type: string
      prefixValidationState:
        description: The prefix validation state
        enum:
        - None
        - Invalid
        - Verified
        - Failed
        - Pending
        - Warning
        - Unknown
        type: string
        readOnly: true
        x-ms-enum:
          name: prefixValidationState
          modelAsString: true
      learnedType:
        description: The prefix learned type
        enum:
        - None
        - ViaServiceProvider
        - ViaSession
        type: string
        readOnly: true
        x-ms-enum:
          name: learnedType
          modelAsString: true
      errorMessage:
        description: The error message for validation state
        type: string
        readOnly: true
      events:
        description: The list of events for peering service prefix
        type: array
        items:
          $ref: '#/definitions/PeeringServicePrefixEvent'
        readOnly: true
      provisioningState:
        description: The provisioning state of the resource.
        enum:
        - Succeeded
        - Updating
        - Deleting
        - Failed
        type: string
        readOnly: true
        x-ms-enum:
          name: provisioningState
          modelAsString: true
  ErrorResponse:
    description: The error response that indicates why an operation has failed.
    type: object
    properties:
      code:
        description: The error code.
        type: string
        readOnly: true
      message:
        description: The error message.
        type: string
        readOnly: true
  PeeringServicePrefixListResult:
    description: The paginated list of peering service prefixes.
    type: object
    properties:
      value:
        description: The list of peering service prefixes.
        type: array
        items:
          $ref: '#/definitions/PeeringServicePrefix'
      nextLink:
        description: The link to fetch the next page of peering service prefixes.
        type: string
  Resource:
    description: The ARM resource class.
    type: object
    properties:
      name:
        description: The name of the resource.
        type: string
        readOnly: true
      id:
        description: The ID of the resource.
        type: string
        readOnly: true
      type:
        description: The type of the resource.
        type: string
        readOnly: true
    x-ms-azure-resource: true
  PeeringServicePrefixEvent:
    description: The details of the event associated with a prefix.
    type: object
    properties:
      eventTimestamp:
        format: date-time
        description: The timestamp of the event associated with a prefix.
        type: string
        readOnly: true
      eventType:
        description: The type of the event associated with a prefix.
        type: string
        readOnly: true
      eventSummary:
        description: The summary of the event associated with a prefix.
        type: string
        readOnly: true
      eventLevel:
        description: The level of the event associated with a prefix.
        type: string
        readOnly: true
      eventDescription:
        description: The description of the event associated with a prefix.
        type: string
        readOnly: true
  PeeringServicePrefix:
    description: The peering service prefix class.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/PeeringServicePrefixProperties'
        description: Gets or sets the peering prefix properties.
        x-ms-client-flatten: true
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: The client API version.
    required: true
    type: string
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The Azure subscription ID.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'