Azure ExpressRoute Express Route Port Authorizations API

openapi: 3.2.0
info:
  title: Microsoft Azure Express Route Express Route Port…
  version: '2026-03-01'
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged ExpressRoutePortAuthorizations across 2 of this provider''s published API definitions: microsoft-azure-express-route-expressroute-swagger.json, microsoft-azure-express-route-expressroute-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ExpressRoutePortAuthorizations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations
  : get:
      operationId: ExpressRoutePortAuthorizations_List
      tags:
      - ExpressRoutePortAuthorizations
      description: Gets all authorizations in an express route port.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: expressRoutePortName
        in: path
        description: The name of the express route port.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRoutePortAuthorizationListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        List ExpressRoutePort Authorization:
          $ref: ./examples/ExpressRoutePortAuthorizationList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Express route port authorizations list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations/{authorizationName}
  : get:
      operationId: ExpressRoutePortAuthorizations_Get
      tags:
      - ExpressRoutePortAuthorizations
      description: Gets the specified authorization from the specified express route port.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: expressRoutePortName
        in: path
        description: The name of the express route port.
        required: true
        schema:
          type: string
      - name: authorizationName
        in: path
        description: The name of the authorization.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRoutePortAuthorization'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        Get ExpressRoutePort Authorization:
          $ref: ./examples/ExpressRoutePortAuthorizationGet.json
      summary: Express route port authorizations get
      x-summary-source: derived
    put:
      operationId: ExpressRoutePortAuthorizations_CreateOrUpdate
      tags:
      - ExpressRoutePortAuthorizations
      description: Creates or updates an authorization in the specified express route port.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: expressRoutePortName
        in: path
        description: The name of the express route port.
        required: true
        schema:
          type: string
      - name: authorizationName
        in: path
        description: The name of the authorization.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'ExpressRoutePortAuthorization' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRoutePortAuthorization'
        '201':
          description: Resource 'ExpressRoutePortAuthorization' create operation succeeded
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
            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/ExpressRoutePortAuthorization'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        Create ExpressRoutePort Authorization:
          $ref: ./examples/ExpressRoutePortAuthorizationCreate.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
        final-state-schema: '#/definitions/ExpressRoutePortAuthorization'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpressRoutePortAuthorization'
        description: Parameters supplied to the create or update express route port authorization operation.
        required: true
      summary: Express route port authorizations create or update
      x-summary-source: derived
    delete:
      operationId: ExpressRoutePortAuthorizations_Delete
      tags:
      - ExpressRoutePortAuthorizations
      description: Deletes the specified authorization from the specified express route port.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: expressRoutePortName
        in: path
        description: The name of the express route port.
        required: true
        schema:
          type: string
      - name: authorizationName
        in: path
        description: The name of the authorization.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
                format: uri
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            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
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        Delete ExpressRoutePort Authorization:
          $ref: ./examples/ExpressRoutePortAuthorizationDelete.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Express route port authorizations delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations/{authorizationName}/listKeys
  : post:
      operationId: ExpressRoutePortAuthorizations_ListKeys
      tags:
      - ExpressRoutePortAuthorizations
      description: Gets the authorization key associated with the specified express route port authorization.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: expressRoutePortName
        in: path
        description: The name of the express route port.
        required: true
        schema:
          type: string
      - name: authorizationName
        in: path
        description: The name of the authorization.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/ExpressRouteAuthorizationKey
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        List ExpressRoutePort Authorization Keys:
          $ref: ./examples/ExpressRoutePortAuthorizationListKeys.json
      summary: Express route port authorizations list keys
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ExpressRoutePortAuthorizationListResult:
      type: object
      title: ExpressRoute Port Authorization List Result
      description: Paged collection of ExpressRoutePortAuthorization items
      properties:
        value:
          type: array
          description: The ExpressRoutePortAuthorization items on this page
          items:
            $ref: '#/components/schemas/ExpressRoutePortAuthorization'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ExpressRoutePortAuthorizationPropertiesFormat:
      type: object
      title: ExpressRoute Port Authorization Properties
      description: Properties of ExpressRoutePort Authorization.
      properties:
        authorizationKey:
          type: string
          description: The authorization key.
          readOnly: true
        authorizationUseStatus:
          $ref: ./common.json#/definitions/ExpressRoutePortAuthorizationUseStatus
          description: The authorization use status.
          readOnly: true
        circuitResourceUri:
          type: string
          description: The reference to the ExpressRoute circuit resource using the authorization.
          readOnly: true
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the authorization resource.
          readOnly: true
    ExpressRoutePortAuthorization:
      type: object
      title: ExpressRoute Port Authorization
      description: ExpressRoutePort Authorization resource definition.
      properties:
        properties:
          $ref: '#/components/schemas/ExpressRoutePortAuthorizationPropertiesFormat'
          description: ExpressRoutePort properties.
          x-ms-client-flatten: true
        etag:
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
          readOnly: true
      allOf:
      - $ref: ./common.json#/definitions/SubResourceModel
  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.
x-refined-from:
- microsoft-azure-express-route-expressroute-swagger.json
- microsoft-azure-express-route-expressroute-openapi.json