Azure ExpressRoute Service Endpoint Policies API

openapi: 3.2.0
info:
  title: Microsoft Azure Express Route Service Endpoint Policies API
  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 ServiceEndpointPolicies 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: ServiceEndpointPolicies
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/serviceEndpointPolicies:
    get:
      operationId: ServiceEndpointPolicies_List
      tags:
      - ServiceEndpointPolicies
      description: Gets all the service endpoint policies in a subscription.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceEndpointPolicyListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        List all service endpoint policy:
          $ref: ./examples/ServiceEndpointPolicyListAll.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Service endpoint policies list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies:
    get:
      operationId: ServiceEndpointPolicies_ListByResourceGroup
      tags:
      - ServiceEndpointPolicies
      description: Gets all service endpoint Policies in a resource group.
      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
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceEndpointPolicyListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        List resource group service endpoint policies:
          $ref: ./examples/ServiceEndpointPolicyList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Service endpoint policies list by resource group
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}
  : get:
      operationId: ServiceEndpointPolicies_Get
      tags:
      - ServiceEndpointPolicies
      description: Gets the specified service Endpoint Policies in a specified resource group.
      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: serviceEndpointPolicyName
        in: path
        description: The name of the service endpoint policy.
        required: true
        schema:
          type: string
      - name: $expand
        in: query
        description: Expands referenced resources.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceEndpointPolicy'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        Get service endPoint Policy:
          $ref: ./examples/ServiceEndpointPolicyGet.json
      summary: Service endpoint policies get
      x-summary-source: derived
    put:
      operationId: ServiceEndpointPolicies_CreateOrUpdate
      tags:
      - ServiceEndpointPolicies
      description: Creates or updates a service Endpoint Policies.
      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: serviceEndpointPolicyName
        in: path
        description: The name of the service endpoint policy.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'ServiceEndpointPolicy' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceEndpointPolicy'
        '201':
          description: Resource 'ServiceEndpointPolicy' 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/ServiceEndpointPolicy'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        Create service endpoint policy:
          $ref: ./examples/ServiceEndpointPolicyCreate.json
        Create service endpoint policy with definition:
          $ref: ./examples/ServiceEndpointPolicyCreateWithDefinition.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
        final-state-schema: '#/definitions/ServiceEndpointPolicy'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceEndpointPolicy'
        description: Parameters supplied to the create or update service endpoint policy operation.
        required: true
      summary: Service endpoint policies create or update
      x-summary-source: derived
    patch:
      operationId: ServiceEndpointPolicies_UpdateTags
      tags:
      - ServiceEndpointPolicies
      description: Updates tags of a service endpoint policy.
      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: serviceEndpointPolicyName
        in: path
        description: The name of the service endpoint policy.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceEndpointPolicy'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        Update service endpoint policy tags:
          $ref: ./examples/ServiceEndpointPolicyUpdateTags.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: ./common.json#/definitions/TagsObject
        description: Parameters supplied to update service endpoint policy tags.
        required: true
      summary: Service endpoint policies update tags
      x-summary-source: derived
    delete:
      operationId: ServiceEndpointPolicies_Delete
      tags:
      - ServiceEndpointPolicies
      description: Deletes the specified service endpoint policy.
      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: serviceEndpointPolicyName
        in: path
        description: The name of the service endpoint policy.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            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 service endpoint policy:
          $ref: ./examples/ServiceEndpointPolicyDelete.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Service endpoint policies delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ServiceEndpointPolicyPropertiesFormat:
      type: object
      description: Service Endpoint Policy resource.
      properties:
        serviceEndpointPolicyDefinitions:
          type: array
          description: A collection of service endpoint policy definitions of the service endpoint policy.
          items:
            $ref: '#/components/schemas/ServiceEndpointPolicyDefinition'
        subnets:
          type: array
          description: A collection of references to subnets.
          items:
            $ref: ./virtualNetwork.json#/definitions/Subnet
          readOnly: true
        resourceGuid:
          type: string
          description: The resource GUID property of the service endpoint policy resource.
          readOnly: true
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the service endpoint policy resource.
          readOnly: true
        serviceAlias:
          type: string
          description: The alias indicating if the policy belongs to a service
        contextualServiceEndpointPolicies:
          type: array
          description: A collection of contextual service endpoint policy.
          items:
            type: string
    ServiceEndpointPolicyDefinitionPropertiesFormat:
      type: object
      description: Service Endpoint policy definition resource.
      properties:
        description:
          type: string
          description: A description for this rule. Restricted to 140 chars.
        service:
          type: string
          description: Service endpoint name.
        serviceResources:
          type: array
          description: A list of service resources.
          items:
            type: string
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the service endpoint policy definition resource.
          readOnly: true
    ServiceEndpointPolicy:
      type: object
      description: Service End point policy resource.
      properties:
        properties:
          $ref: '#/components/schemas/ServiceEndpointPolicyPropertiesFormat'
          description: Properties of the service end point policy.
          x-ms-client-flatten: true
        etag:
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
          readOnly: true
        kind:
          type: string
          description: Kind of service endpoint policy. This is metadata used for the Azure portal experience.
          readOnly: true
      allOf:
      - $ref: ./common.json#/definitions/Resource
    ServiceEndpointPolicyListResult:
      type: object
      description: The response of a ServiceEndpointPolicy list operation.
      properties:
        value:
          type: array
          description: The ServiceEndpointPolicy items on this page
          items:
            $ref: '#/components/schemas/ServiceEndpointPolicy'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ServiceEndpointPolicyDefinition:
      type: object
      description: Service Endpoint policy definitions.
      properties:
        properties:
          $ref: '#/components/schemas/ServiceEndpointPolicyDefinitionPropertiesFormat'
          description: Properties of the service endpoint policy definition.
          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