Microsoft Azure TrafficControllerInterface API

openapi: 3.2.0
info:
  title: Microsoft Azure TrafficController Traffic Controller…
  version: 2023-05-01-preview
  description: Traffic Controller Provider management API.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: TrafficControllerInterface
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceNetworking/trafficControllers:
    get:
      operationId: microsoftAzureTrafficcontrollerinterfaceListbysubscription
      tags:
      - TrafficControllerInterface
      description: List TrafficController resources by subscription ID
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrafficControllerListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Traffic Controllers List:
          $ref: ./examples/TrafficControllersGetList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers
  : get:
      operationId: microsoftAzureTrafficcontrollerinterfaceListbyresourcegroup
      tags:
      - TrafficControllerInterface
      description: List TrafficController resources by resource group
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrafficControllerListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Traffic Controllers:
          $ref: ./examples/TrafficControllersGet.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}
  : get:
      operationId: microsoftAzureTrafficcontrollerinterfaceGet
      tags:
      - TrafficControllerInterface
      description: Get a TrafficController
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: trafficControllerName
        in: path
        description: traffic controller name for path
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrafficController'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Traffic Controller:
          $ref: ./examples/TrafficControllerGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      operationId: microsoftAzureTrafficcontrollerinterfaceCreateorupdate
      tags:
      - TrafficControllerInterface
      description: Create a TrafficController
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: trafficControllerName
        in: path
        description: traffic controller name for path
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
      responses:
        '200':
          description: Resource 'TrafficController' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrafficController'
        '201':
          description: Resource 'TrafficController' create operation succeeded
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrafficController'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Put Traffic Controller:
          $ref: ./examples/TrafficControllerPut.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrafficController'
        description: Resource create parameters.
        required: true
    patch:
      operationId: microsoftAzureTrafficcontrollerinterfaceUpdate
      tags:
      - TrafficControllerInterface
      description: Update a TrafficController
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: trafficControllerName
        in: path
        description: traffic controller name for path
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrafficController'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Patch Traffic Controller:
          $ref: ./examples/TrafficControllerPatch.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrafficControllerUpdate'
        description: The resource properties to be updated.
        required: true
    delete:
      operationId: microsoftAzureTrafficcontrollerinterfaceDelete
      tags:
      - TrafficControllerInterface
      description: Delete a TrafficController
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: trafficControllerName
        in: path
        description: traffic controller name for path
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
        '204':
          description: Resource deleted successfully.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete Traffic Controller:
          $ref: ./examples/TrafficControllerDelete.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    ProvisioningState:
      type: string
      enum:
      - Provisioning
      - Updating
      - Deleting
      - Accepted
      - Succeeded
      - Failed
      - Canceled
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
    TrafficControllerListResult:
      type: object
      description: The response of a TrafficController list operation.
      properties:
        value:
          type: array
          description: The TrafficController items on this page
          items:
            $ref: '#/components/schemas/TrafficController'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ResourceId:
      type: object
      description: Resource ID definition used by parent to reference child resources.
      properties:
        id:
          type: string
          description: Resource ID of child resource.
      required:
      - id
    TrafficController:
      type: object
      description: Concrete tracked resource types can be created by aliasing this type using a specific property type.
      properties:
        properties:
          $ref: '#/components/schemas/TrafficControllerProperties'
          description: The resource-specific properties for this resource.
          x-ms-client-flatten: true
          x-ms-mutability:
          - read
          - create
      allOf:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource
    TrafficControllerUpdate:
      type: object
      description: The type used for update operations of the TrafficController.
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
    TrafficControllerProperties:
      type: object
      description: Traffic Controller Properties.
      properties:
        configurationEndpoints:
          type: array
          description: Configuration Endpoints.
          items:
            type: string
          readOnly: true
        frontends:
          type: array
          description: Frontends References List
          items:
            $ref: '#/components/schemas/ResourceId'
          readOnly: true
        associations:
          type: array
          description: Associations References List
          items:
            $ref: '#/components/schemas/ResourceId'
          readOnly: true
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The status of the last operation.
          readOnly: true
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.