{ "swagger": "2.0", "info": { "title": "WebApplicationFirewallManagement", "version": "2026-03-01", "description": "APIs to manage Microsoft Azure network resources.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "ExpressRouteProviderPorts" }, { "name": "ExpressRouteCircuitAuthorizations" }, { "name": "ExpressRouteCircuits" }, { "name": "ExpressRouteCircuitStats" }, { "name": "ExpressRouteCircuitPeerings" }, { "name": "ExpressRouteCircuitArpTable" }, { "name": "ExpressRouteCircuitRoutesTable" }, { "name": "ExpressRouteCircuitRoutesTableSummary" }, { "name": "ExpressRouteCircuitConnections" }, { "name": "PeerExpressRouteCircuitConnections" }, { "name": "ExpressRouteCrossConnections" }, { "name": "ExpressRouteCrossConnectionArpTable" }, { "name": "ExpressRouteCrossConnectionRouteTableSummary" }, { "name": "ExpressRouteCrossConnectionRouteTable" }, { "name": "ExpressRouteCrossConnectionPeerings" }, { "name": "ExpressRoutePortsLocations" }, { "name": "ExpressRoutePorts" }, { "name": "ExpressRouteLinks" }, { "name": "ExpressRoutePortAuthorizations" }, { "name": "ExpressRouteLags" }, { "name": "ExpressRouteLagLinks" }, { "name": "ExpressRouteLagMembers" }, { "name": "ExpressRouteLagAuthorizations" }, { "name": "RouteFilters" }, { "name": "RouteFilterRules" }, { "name": "ServiceEndpointPolicies" }, { "name": "serviceEndpointPolicyDefinitions" }, { "name": "ServiceEndpointPolicyDefinitions" }, { "name": "ExpressRouteServiceProviders" }, { "name": "BgpServiceCommunities" } ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePorts": { "get": { "operationId": "ExpressRoutePorts_List", "tags": [ "ExpressRoutePorts" ], "description": "List all the ExpressRoutePort resources in the specified 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": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExpressRoutePortListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRoutePortList": { "$ref": "./examples/ExpressRoutePortList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations": { "get": { "operationId": "ExpressRoutePortsLocations_List", "tags": [ "ExpressRoutePortsLocations" ], "description": "Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExpressRoutePortsLocationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRoutePortsLocationList": { "$ref": "./examples/ExpressRoutePortsLocationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations/{locationName}": { "get": { "operationId": "ExpressRoutePortsLocations_Get", "tags": [ "ExpressRoutePortsLocations" ], "description": "Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "locationName", "in": "path", "description": "Name of the requested ExpressRoutePort peering location.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRoutePortsLocation" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRoutePortsLocationGet": { "$ref": "./examples/ExpressRoutePortsLocationGet.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/bgpServiceCommunities": { "get": { "operationId": "BgpServiceCommunities_List", "tags": [ "BgpServiceCommunities" ], "description": "Gets all the available bgp service communities.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BgpServiceCommunityListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ServiceCommunityList": { "$ref": "./examples/ServiceCommunityList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCircuits": { "get": { "operationId": "ExpressRouteCircuits_ListAll", "tags": [ "ExpressRouteCircuits" ], "description": "Gets all the express route circuits 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.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List ExpressRouteCircuits in a subscription": { "$ref": "./examples/ExpressRouteCircuitListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCrossConnections": { "get": { "operationId": "ExpressRouteCrossConnections_List", "tags": [ "ExpressRouteCrossConnections" ], "description": "Retrieves all the ExpressRouteCrossConnections in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation. For example, you can use $filter=name eq '{circuitServiceKey}'.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteCrossConnectionList": { "$ref": "./examples/ExpressRouteCrossConnectionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteLags": { "get": { "operationId": "ExpressRouteLags_List", "tags": [ "ExpressRouteLags" ], "description": "List all the ExpressRouteLag resources in the specified 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": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExpressRouteLagListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List all express route lags": { "$ref": "./examples/ExpressRouteLagList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts": { "get": { "operationId": "ExpressRouteProviderPortsLocation_List", "tags": [ "ExpressRouteProviderPorts" ], "description": "Retrieves all the ExpressRouteProviderPorts in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation. For example, you can use $filter=location eq '{state}'.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExpressRouteProviderPortListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteProviderPortList": { "$ref": "./examples/expressRouteProviderPortList.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts/{providerport}": { "get": { "operationId": "ExpressRouteProviderPort", "tags": [ "ExpressRouteProviderPorts" ], "description": "Retrieves detail of a provider port.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "providerport", "in": "path", "description": "The name of the provider port.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteProviderPort" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteProviderPort": { "$ref": "./examples/expressRouteProviderPort.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteServiceProviders": { "get": { "operationId": "ExpressRouteServiceProviders_List", "tags": [ "ExpressRouteServiceProviders" ], "description": "Gets all the available express route service providers.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List ExpressRoute providers": { "$ref": "./examples/ExpressRouteProviderList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeFilters": { "get": { "operationId": "RouteFilters_List", "tags": [ "RouteFilters" ], "description": "Gets all route filters 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.", "schema": { "$ref": "#/definitions/RouteFilterListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteFilterList": { "$ref": "./examples/RouteFilterList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/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.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicyListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List all service endpoint policy": { "$ref": "./examples/ServiceEndpointPolicyListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts": { "get": { "operationId": "ExpressRoutePorts_ListByResourceGroup", "tags": [ "ExpressRoutePorts" ], "description": "List all the ExpressRoutePort resources in the 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" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExpressRoutePortListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRoutePortListByResourceGroup": { "$ref": "./examples/ExpressRoutePortListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}": { "get": { "operationId": "ExpressRoutePorts_Get", "tags": [ "ExpressRoutePorts" ], "description": "Retrieves the requested ExpressRoutePort resource.", "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 ExpressRoutePort.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRoutePort" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRoutePortGet": { "$ref": "./examples/ExpressRoutePortGet.json" } } }, "put": { "operationId": "ExpressRoutePorts_CreateOrUpdate", "tags": [ "ExpressRoutePorts" ], "description": "Creates or updates the specified ExpressRoutePort resource.", "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 ExpressRoutePort.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the create ExpressRoutePort operation.", "required": true, "schema": { "$ref": "#/definitions/ExpressRoutePort" } } ], "responses": { "200": { "description": "Resource 'ExpressRoutePort' update operation succeeded", "schema": { "$ref": "#/definitions/ExpressRoutePort" } }, "201": { "description": "Resource 'ExpressRoutePort' create operation succeeded", "schema": { "$ref": "#/definitions/ExpressRoutePort" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRoutePortCreate": { "$ref": "./examples/ExpressRoutePortCreate.json" }, "ExpressRoutePortUpdateLink": { "$ref": "./examples/ExpressRoutePortUpdateLink.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ExpressRoutePort" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ExpressRoutePorts_UpdateTags", "tags": [ "ExpressRoutePorts" ], "description": "Update ExpressRoutePort tags.", "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 ExpressRoutePort.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to update ExpressRoutePort resource tags.", "required": true, "schema": { "$ref": "./common.json#/definitions/TagsObject" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRoutePort" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRoutePortUpdateTags": { "$ref": "./examples/ExpressRoutePortUpdateTags.json" } } }, "delete": { "operationId": "ExpressRoutePorts_Delete", "tags": [ "ExpressRoutePorts" ], "description": "Deletes the specified ExpressRoutePort resource.", "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 ExpressRoutePort.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRoutePortDelete": { "$ref": "./examples/ExpressRoutePortDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/generateLoa": { "post": { "operationId": "ExpressRoutePorts_GenerateLOA", "tags": [ "ExpressRoutePorts" ], "description": "Generate a letter of authorization for the requested ExpressRoutePort resource.", "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 ExpressRoutePort.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "Request parameters supplied to generate a letter of authorization.", "required": true, "schema": { "$ref": "#/definitions/GenerateExpressRoutePortsLOARequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GenerateExpressRoutePortsLOAResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "GenerateExpressRoutePortLOA": { "$ref": "./examples/GenerateExpressRoutePortsLOA.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links": { "get": { "operationId": "ExpressRouteLinks_List", "tags": [ "ExpressRouteLinks" ], "description": "Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort resource.", "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 ExpressRoutePort.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteLinkListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteLinkGet": { "$ref": "./examples/ExpressRouteLinkList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links/{linkName}": { "get": { "operationId": "ExpressRouteLinks_Get", "tags": [ "ExpressRouteLinks" ], "description": "Retrieves the specified ExpressRouteLink resource.", "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, "type": "string" }, { "name": "linkName", "in": "path", "description": "The name of the express route link.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteLink" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteLinkGet": { "$ref": "./examples/ExpressRouteLinkGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits": { "get": { "operationId": "ExpressRouteCircuits_List", "tags": [ "ExpressRouteCircuits" ], "description": "Gets all the express route circuits 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.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List ExpressRouteCircuits in a resource group": { "$ref": "./examples/ExpressRouteCircuitListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}": { "get": { "operationId": "ExpressRouteCircuits_Get", "tags": [ "ExpressRouteCircuits" ], "description": "Gets information about the specified express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuit" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitGet.json" }, "Get MultiCloud ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteMultiCloudCircuitGet.json" } } }, "put": { "operationId": "ExpressRouteCircuits_CreateOrUpdate", "tags": [ "ExpressRouteCircuits" ], "description": "Creates or updates an express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the create or update express route circuit operation.", "required": true, "schema": { "$ref": "#/definitions/ExpressRouteCircuit" } } ], "responses": { "200": { "description": "Resource 'ExpressRouteCircuit' update operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteCircuit" } }, "201": { "description": "Resource 'ExpressRouteCircuit' create operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteCircuit" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitCreate.json" }, "Create ExpressRouteCircuit on ExpressRouteLag": { "$ref": "./examples/ExpressRouteCircuitCreateOnExpressRouteLag.json" }, "Create ExpressRouteCircuit on ExpressRouteLag with Authorization Key": { "$ref": "./examples/ExpressRouteCircuitCreateOnExpressRouteLagWithAuthorizationKey.json" }, "Create ExpressRouteCircuit on ExpressRoutePort": { "$ref": "./examples/ExpressRouteCircuitCreateOnExpressRoutePort.json" }, "Create MultiCloud ExpressRouteCircuit with ActivationKey": { "$ref": "./examples/ExpressRouteMultiCloudCircuitCreateWithActivationKey.json" }, "Create MultiCloud ExpressRouteCircuit with PartnerAccountId": { "$ref": "./examples/ExpressRouteMultiCloudCircuitCreateWithPartnerAccountId.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ExpressRouteCircuit" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ExpressRouteCircuits_UpdateTags", "tags": [ "ExpressRouteCircuits" ], "description": "Updates an express route circuit tags.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to update express route circuit tags.", "required": true, "schema": { "$ref": "./common.json#/definitions/TagsObject" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuit" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update Express Route Circuit Tags": { "$ref": "./examples/ExpressRouteCircuitUpdateTags.json" } } }, "delete": { "operationId": "ExpressRouteCircuits_Delete", "tags": [ "ExpressRouteCircuits" ], "description": "Deletes the specified express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitDelete.json" }, "Delete MultiCloud ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteMultiCloudCircuitDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations": { "get": { "operationId": "ExpressRouteCircuitAuthorizations_List", "tags": [ "ExpressRouteCircuitAuthorizations" ], "description": "Gets all authorizations in an express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AuthorizationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}": { "get": { "operationId": "ExpressRouteCircuitAuthorizations_Get", "tags": [ "ExpressRouteCircuitAuthorizations" ], "description": "Gets the specified authorization from the specified express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "authorizationName", "in": "path", "description": "The name of the authorization.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitAuthorization" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationGet.json" } } }, "put": { "operationId": "ExpressRouteCircuitAuthorizations_CreateOrUpdate", "tags": [ "ExpressRouteCircuitAuthorizations" ], "description": "Creates or updates an authorization in the specified express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "authorizationName", "in": "path", "description": "The name of the authorization.", "required": true, "type": "string" }, { "name": "authorizationParameters", "in": "body", "description": "Parameters supplied to the create or update express route circuit authorization operation.", "required": true, "schema": { "$ref": "#/definitions/ExpressRouteCircuitAuthorization" } } ], "responses": { "200": { "description": "Resource 'ExpressRouteCircuitAuthorization' update operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteCircuitAuthorization" } }, "201": { "description": "Resource 'ExpressRouteCircuitAuthorization' create operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteCircuitAuthorization" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ExpressRouteCircuitAuthorization" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ExpressRouteCircuitAuthorizations_Delete", "tags": [ "ExpressRouteCircuitAuthorizations" ], "description": "Deletes the specified authorization from the specified express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "authorizationName", "in": "path", "description": "The name of the authorization.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}/listKeys": { "post": { "operationId": "ExpressRouteCircuitAuthorizations_ListKeys", "tags": [ "ExpressRouteCircuitAuthorizations" ], "description": "Gets the authorization key associated with the specified express route circuit 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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "authorizationName", "in": "path", "description": "The name of the authorization.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/ExpressRouteAuthorizationKey" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List ExpressRouteCircuit Authorization Keys": { "$ref": "./examples/ExpressRouteCircuitAuthorizationListKeys.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/getCircuitLinkFailoverAllTestsDetails": { "post": { "operationId": "ExpressRouteCircuits_GetCircuitLinkFailoverAllTestsDetails", "tags": [ "ExpressRouteCircuits" ], "description": "Retrieves the details of all the link failover tests performed on the express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "failoverTestType", "in": "query", "description": "The type of failover test.", "required": false, "type": "string" }, { "name": "fetchLatest", "in": "query", "description": "Fetch only the latest tests.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/ExpressRouteLinkFailoverAllTestsDetails" } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteCircuitGetCircuitLinkFailoverAllTestsDetails": { "$ref": "./examples/ExpressRouteCircuitGetCircuitLinkFailoverAllTestsDetails.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ExpressRouteLinkFailoverAllTestsDetailsArray" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/getCircuitLinkFailoverSingleTestDetails": { "post": { "operationId": "ExpressRouteCircuits_GetCircuitLinkFailoverSingleTestDetails", "tags": [ "ExpressRouteCircuits" ], "description": "Retrieves the details of a particular link failover test performed on the express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "linkType", "in": "query", "description": "The link type.", "required": true, "type": "string" }, { "name": "circuitTestCategory", "in": "query", "description": "The circuit test category.", "required": true, "type": "string" }, { "name": "failoverTestId", "in": "query", "description": "The unique Guid value which identifies the test.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/ExpressRouteLinkFailoverSingleTestDetails" } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteCircuitGetCircuitLinkFailoverSingleTestDetails": { "$ref": "./examples/ExpressRouteCircuitGetCircuitLinkFailoverSingleTestDetails.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ExpressRouteLinkFailoverSingleTestDetailsArray" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings": { "get": { "operationId": "ExpressRouteCircuitPeerings_List", "tags": [ "ExpressRouteCircuitPeerings" ], "description": "Gets all peerings in a specified express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitPeeringListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List ExpressRouteCircuit Peerings": { "$ref": "./examples/ExpressRouteCircuitPeeringList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}": { "get": { "operationId": "ExpressRouteCircuitPeerings_Get", "tags": [ "ExpressRouteCircuitPeerings" ], "description": "Gets the specified peering for the express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitPeering" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get ExpressRouteCircuit Peering": { "$ref": "./examples/ExpressRouteCircuitPeeringGet.json" } } }, "put": { "operationId": "ExpressRouteCircuitPeerings_CreateOrUpdate", "tags": [ "ExpressRouteCircuitPeerings" ], "description": "Creates or updates a peering in the specified express route circuits.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" }, { "name": "peeringParameters", "in": "body", "description": "Parameters supplied to the create or update express route circuit peering operation.", "required": true, "schema": { "$ref": "#/definitions/ExpressRouteCircuitPeering" } } ], "responses": { "200": { "description": "Resource 'ExpressRouteCircuitPeering' update operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteCircuitPeering" } }, "201": { "description": "Resource 'ExpressRouteCircuitPeering' create operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteCircuitPeering" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create ExpressRouteCircuit Peerings": { "$ref": "./examples/ExpressRouteCircuitPeeringCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ExpressRouteCircuitPeering" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ExpressRouteCircuitPeerings_Delete", "tags": [ "ExpressRouteCircuitPeerings" ], "description": "Deletes the specified peering from the specified express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete ExpressRouteCircuit Peerings": { "$ref": "./examples/ExpressRouteCircuitPeeringDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/arpTables/{devicePath}": { "post": { "operationId": "ExpressRouteCircuits_ListArpTable", "tags": [ "ExpressRouteCircuitArpTable" ], "description": "Gets the currently advertised ARP table associated with the express route circuit 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" }, { "name": "circuitName", "in": "path", "description": "The name of the express route port.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" }, { "name": "devicePath", "in": "path", "description": "The name of the arpTables.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitsArpTableListResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List ARP Table": { "$ref": "./examples/ExpressRouteCircuitARPTableList.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ExpressRouteCircuitsArpTableListResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections": { "get": { "operationId": "ExpressRouteCircuitConnections_List", "tags": [ "ExpressRouteCircuitConnections" ], "description": "Gets all global reach connections associated with a private peering in an express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List ExpressRouteCircuit Connection": { "$ref": "./examples/ExpressRouteCircuitConnectionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}": { "get": { "operationId": "ExpressRouteCircuitConnections_Get", "tags": [ "ExpressRouteCircuitConnections" ], "description": "Gets the specified Express Route Circuit Connection from the specified express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the express route circuit connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteCircuitConnectionGet": { "$ref": "./examples/ExpressRouteCircuitConnectionGet.json" } } }, "put": { "operationId": "ExpressRouteCircuitConnections_CreateOrUpdate", "tags": [ "ExpressRouteCircuitConnections" ], "description": "Creates or updates a Express Route Circuit Connection in the specified express route circuits.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the express route circuit connection.", "required": true, "type": "string" }, { "name": "expressRouteCircuitConnectionParameters", "in": "body", "description": "Parameters supplied to the create or update express route circuit connection operation.", "required": true, "schema": { "$ref": "#/definitions/ExpressRouteCircuitConnection" } } ], "responses": { "200": { "description": "Resource 'ExpressRouteCircuitConnection' update operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteCircuitConnection" } }, "201": { "description": "Resource 'ExpressRouteCircuitConnection' create operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteCircuitConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteCircuitConnectionCreate": { "$ref": "./examples/ExpressRouteCircuitConnectionCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ExpressRouteCircuitConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ExpressRouteCircuitConnections_Delete", "tags": [ "ExpressRouteCircuitConnections" ], "description": "Deletes the specified Express Route Circuit Connection from the specified express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the express route circuit connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitConnectionDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections": { "get": { "operationId": "PeerExpressRouteCircuitConnections_List", "tags": [ "PeerExpressRouteCircuitConnections" ], "description": "Gets all global reach peer connections associated with a private peering in an express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PeerExpressRouteCircuitConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List Peer ExpressRouteCircuit Connection": { "$ref": "./examples/PeerExpressRouteCircuitConnectionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections/{connectionName}": { "get": { "operationId": "PeerExpressRouteCircuitConnections_Get", "tags": [ "PeerExpressRouteCircuitConnections" ], "description": "Gets the specified Peer Express Route Circuit Connection from the specified express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PeerExpressRouteCircuitConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "PeerExpressRouteCircuitConnectionGet": { "$ref": "./examples/PeerExpressRouteCircuitConnectionGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTables/{devicePath}": { "post": { "operationId": "ExpressRouteCircuits_ListRoutesTable", "tags": [ "ExpressRouteCircuitRoutesTable" ], "description": "Gets the currently advertised routes table associated with the express route circuit 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" }, { "name": "circuitName", "in": "path", "description": "The name of the express route port.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" }, { "name": "devicePath", "in": "path", "description": "The name of the routeTables.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitsRoutesTableListResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List Route Tables": { "$ref": "./examples/ExpressRouteCircuitRouteTableList.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ExpressRouteCircuitsRoutesTableListResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTablesSummary/{devicePath}": { "post": { "operationId": "ExpressRouteCircuits_ListRoutesTableSummary", "tags": [ "ExpressRouteCircuitRoutesTableSummary" ], "description": "Gets the currently advertised routes table summary associated with the express route circuit 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" }, { "name": "circuitName", "in": "path", "description": "The name of the express route port.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" }, { "name": "devicePath", "in": "path", "description": "The name of the routeTablesSummary.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitsRoutesTableSummaryListResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List Route Table Summary": { "$ref": "./examples/ExpressRouteCircuitRouteTableSummaryList.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ExpressRouteCircuitsRoutesTableSummaryListResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/stats": { "get": { "operationId": "ExpressRouteCircuits_GetPeeringStats", "tags": [ "ExpressRouteCircuitStats" ], "description": "Gets all stats from an express route circuit 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" }, { "name": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitStats" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get ExpressRoute Circuit Peering Traffic Stats": { "$ref": "./examples/ExpressRouteCircuitPeeringStats.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/startCircuitLinkFailoverTest": { "post": { "operationId": "ExpressRouteCircuits_StartCircuitLinkFailoverTest", "tags": [ "ExpressRouteCircuits" ], "description": "Starts link failover simulation on the express route circuit for the specified link type and test category.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "linkType", "in": "query", "description": "The link type.", "required": true, "type": "string" }, { "name": "circuitTestCategory", "in": "query", "description": "The circuit test category.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/stringApplicationJson" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteCircuitStartCircuitLinkFailoverTest": { "$ref": "./examples/ExpressRouteCircuitStartCircuitLinkFailoverTest.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "./common.json#/definitions/stringApplicationJson" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/stats": { "get": { "operationId": "ExpressRouteCircuits_GetStats", "tags": [ "ExpressRouteCircuitStats" ], "description": "Gets all the stats from an express route circuit 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" }, { "name": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitStats" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get ExpressRoute Circuit Traffic Stats": { "$ref": "./examples/ExpressRouteCircuitStats.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/stopCircuitLinkFailoverTest": { "post": { "operationId": "ExpressRouteCircuits_StopCircuitLinkFailoverTest", "tags": [ "ExpressRouteCircuits" ], "description": "Stops link failover simulation on the express route circuit.", "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": "circuitName", "in": "path", "description": "The name of express route circuit.", "required": true, "type": "string" }, { "name": "stopParameters", "in": "body", "description": "Parameters supplied to stop the link failover simulation on the express route circuit.", "required": true, "schema": { "$ref": "#/definitions/ExpressRouteLinkFailoverStopApiParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/stringApplicationJson" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteCircuitStopCircuitLinkFailoverTest": { "$ref": "./examples/ExpressRouteCircuitStopCircuitLinkFailoverTest.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "./common.json#/definitions/stringApplicationJson" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections": { "get": { "operationId": "ExpressRouteCrossConnections_ListByResourceGroup", "tags": [ "ExpressRouteCrossConnections" ], "description": "Retrieves all the ExpressRouteCrossConnections 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.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteCrossConnectionListByResourceGroup": { "$ref": "./examples/ExpressRouteCrossConnectionListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}": { "get": { "operationId": "ExpressRouteCrossConnections_Get", "tags": [ "ExpressRouteCrossConnections" ], "description": "Gets details about the specified ExpressRouteCrossConnection.", "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": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "GetExpressRouteCrossConnection": { "$ref": "./examples/ExpressRouteCrossConnectionGet.json" } } }, "put": { "operationId": "ExpressRouteCrossConnections_CreateOrUpdate", "tags": [ "ExpressRouteCrossConnections" ], "description": "Update the specified ExpressRouteCrossConnection.", "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": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the update express route crossConnection operation.", "required": true, "schema": { "$ref": "#/definitions/ExpressRouteCrossConnection" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "UpdateExpressRouteCrossConnection": { "$ref": "./examples/ExpressRouteCrossConnectionUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ExpressRouteCrossConnection" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ExpressRouteCrossConnections_UpdateTags", "tags": [ "ExpressRouteCrossConnections" ], "description": "Updates an express route cross connection tags.", "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": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" }, { "name": "crossConnectionParameters", "in": "body", "description": "Parameters supplied to update express route cross connection tags.", "required": true, "schema": { "$ref": "./common.json#/definitions/TagsObject" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "UpdateExpressRouteCrossConnectionTags": { "$ref": "./examples/ExpressRouteCrossConnectionUpdateTags.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/commitCircuitMigration": { "post": { "operationId": "ExpressRouteCrossConnections_CommitCircuitMigration", "tags": [ "ExpressRouteCrossConnections" ], "description": "Commits the express route circuit migration for a cross connection.", "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": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to commit the express route circuit migration.", "required": true, "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "CommitExpressRouteCircuitMigration": { "$ref": "./examples/ExpressRouteCrossConnectionCommitCircuitMigration.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/getCircuitMigrationInfo": { "post": { "operationId": "ExpressRouteCrossConnections_GetCircuitMigrationInfo", "tags": [ "ExpressRouteCrossConnections" ], "description": "Gets migration health information for an express route circuit cross connection.", "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": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to get express route circuit migration information.", "required": true, "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitValidateAndHealthCheckRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "GetExpressRouteCircuitMigrationInfo": { "$ref": "./examples/ExpressRouteCrossConnectionGetCircuitMigrationInfo.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/migrateCircuit": { "post": { "operationId": "ExpressRouteCrossConnections_MigrateCircuit", "tags": [ "ExpressRouteCrossConnections" ], "description": "Executes the express route circuit migration for a cross connection.", "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": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to execute the express route circuit migration.", "required": true, "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "MigrateExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCrossConnectionMigrateCircuit.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings": { "get": { "operationId": "ExpressRouteCrossConnectionPeerings_List", "tags": [ "ExpressRouteCrossConnectionPeerings" ], "description": "Gets all peerings in a specified ExpressRouteCrossConnection.", "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": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteCrossConnectionBgpPeeringList": { "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}": { "get": { "operationId": "ExpressRouteCrossConnectionPeerings_Get", "tags": [ "ExpressRouteCrossConnectionPeerings" ], "description": "Gets the specified peering for the ExpressRouteCrossConnection.", "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": "crossConnectionName", "in": "path", "description": "Name for the express route cross connection.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "GetExpressRouteCrossConnectionBgpPeering": { "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringGet.json" } } }, "put": { "operationId": "ExpressRouteCrossConnectionPeerings_CreateOrUpdate", "tags": [ "ExpressRouteCrossConnectionPeerings" ], "description": "Creates or updates a peering in the specified ExpressRouteCrossConnection.", "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": "crossConnectionName", "in": "path", "description": "Name for the express route cross connection.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" }, { "name": "peeringParameters", "in": "body", "description": "Parameters supplied to the create or update ExpressRouteCrossConnection peering operation.", "required": true, "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" } }, "201": { "description": "Resource 'ExpressRouteCrossConnectionPeering' create operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteCrossConnectionBgpPeeringCreate": { "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ExpressRouteCrossConnectionPeering" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ExpressRouteCrossConnectionPeerings_Delete", "tags": [ "ExpressRouteCrossConnectionPeerings" ], "description": "Deletes the specified peering from the ExpressRouteCrossConnection.", "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": "crossConnectionName", "in": "path", "description": "Name for the express route cross connection.", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "DeleteExpressRouteCrossConnectionBgpPeering": { "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/arpTables/{devicePath}": { "post": { "operationId": "ExpressRouteCrossConnections_ListArpTable", "tags": [ "ExpressRouteCrossConnectionArpTable" ], "description": "Gets the currently advertised ARP table associated with the express route cross connection 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" }, { "name": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" }, { "name": "devicePath", "in": "path", "description": "The path of the device.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitsArpTableListResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "GetExpressRouteCrossConnectionsArpTable": { "$ref": "./examples/ExpressRouteCrossConnectionsArpTable.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ExpressRouteCircuitsArpTableListResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/routeTables/{devicePath}": { "post": { "operationId": "ExpressRouteCrossConnections_ListRoutesTable", "tags": [ "ExpressRouteCrossConnectionRouteTable" ], "description": "Gets the currently advertised routes table associated with the express route cross connection 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" }, { "name": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" }, { "name": "devicePath", "in": "path", "description": "The path of the device.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCircuitsRoutesTableListResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "GetExpressRouteCrossConnectionsRouteTable": { "$ref": "./examples/ExpressRouteCrossConnectionsRouteTable.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ExpressRouteCircuitsRoutesTableListResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/routeTablesSummary/{devicePath}": { "post": { "operationId": "ExpressRouteCrossConnections_ListRoutesTableSummary", "tags": [ "ExpressRouteCrossConnectionRouteTableSummary" ], "description": "Gets the route table summary associated with the express route cross connection 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" }, { "name": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" }, { "name": "peeringName", "in": "path", "description": "The name of the peering.", "required": true, "type": "string" }, { "name": "devicePath", "in": "path", "description": "The path of the device.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionsRoutesTableSummaryListResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "GetExpressRouteCrossConnectionsRouteTableSummary": { "$ref": "./examples/ExpressRouteCrossConnectionsRouteTableSummary.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ExpressRouteCrossConnectionsRoutesTableSummaryListResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/prepareCircuitMigration": { "post": { "operationId": "ExpressRouteCrossConnections_PrepareCircuitMigration", "tags": [ "ExpressRouteCrossConnections" ], "description": "Prepares an express route circuit migration for a cross connection.", "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": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to prepare the express route circuit migration.", "required": true, "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "PrepareExpressRouteCircuitMigration": { "$ref": "./examples/ExpressRouteCrossConnectionPrepareCircuitMigration.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/restoreBgpForCircuitMigration": { "post": { "operationId": "ExpressRouteCrossConnections_RestoreBgpForCircuitMigration", "tags": [ "ExpressRouteCrossConnections" ], "description": "Restores BGP sessions as part of an express route circuit migration for a cross connection.", "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": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to restore BGP for the express route circuit migration.", "required": true, "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RestoreBgpForExpressRouteCircuitMigration": { "$ref": "./examples/ExpressRouteCrossConnectionRestoreBgpForCircuitMigration.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/rollbackCircuitMigration": { "post": { "operationId": "ExpressRouteCrossConnections_RollbackCircuitMigration", "tags": [ "ExpressRouteCrossConnections" ], "description": "Rolls back the express route circuit migration for a cross connection.", "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": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to roll back the express route circuit migration.", "required": true, "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RollbackExpressRouteCircuitMigration": { "$ref": "./examples/ExpressRouteCrossConnectionRollbackCircuitMigration.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/shutDownBgpForCircuitMigration": { "post": { "operationId": "ExpressRouteCrossConnections_ShutDownBgpForCircuitMigration", "tags": [ "ExpressRouteCrossConnections" ], "description": "Shuts down BGP sessions as part of an express route circuit migration for a cross connection.", "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": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to shut down BGP for the express route circuit migration.", "required": true, "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ShutDownBgpForExpressRouteCircuitMigration": { "$ref": "./examples/ExpressRouteCrossConnectionShutDownBgpForCircuitMigration.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrateExpressRouteCircuitHealthCheckResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/validateCircuitMigration": { "post": { "operationId": "ExpressRouteCrossConnections_ValidateCircuitMigration", "tags": [ "ExpressRouteCrossConnections" ], "description": "Validates express route circuit migration for a cross connection.", "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": "crossConnectionName", "in": "path", "description": "The name of the ExpressRouteCrossConnection (service key of the circuit).", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to validate express route circuit migration.", "required": true, "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitValidateAndHealthCheckRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrateExpressRouteCircuitValidateResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ValidateExpressRouteCircuitMigration": { "$ref": "./examples/ExpressRouteCrossConnectionValidateCircuitMigration.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrateExpressRouteCircuitValidateResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteLags": { "get": { "operationId": "ExpressRouteLags_ListByResourceGroup", "tags": [ "ExpressRouteLags" ], "description": "List all the ExpressRouteLag resources in the 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" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExpressRouteLagListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List express route lags by resource group": { "$ref": "./examples/ExpressRouteLagListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteLags/{expressRouteLagName}": { "get": { "operationId": "ExpressRouteLags_Get", "tags": [ "ExpressRouteLags" ], "description": "Retrieves the requested ExpressRouteLag resource.", "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": "expressRouteLagName", "in": "path", "description": "The name of ExpressRouteLag.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteLag" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get express route lag": { "$ref": "./examples/ExpressRouteLagGet.json" } } }, "put": { "operationId": "ExpressRouteLags_CreateOrUpdate", "tags": [ "ExpressRouteLags" ], "description": "Creates or updates the specified ExpressRouteLag resource.", "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": "expressRouteLagName", "in": "path", "description": "The name of ExpressRouteLag.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" }, { "name": "resource", "in": "body", "description": "Parameters supplied to the create ExpressRouteLag operation.", "required": true, "schema": { "$ref": "#/definitions/ExpressRouteLag" } } ], "responses": { "200": { "description": "Resource 'ExpressRouteLag' update operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteLag" } }, "201": { "description": "Resource 'ExpressRouteLag' create operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteLag" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create express route lag": { "$ref": "./examples/ExpressRouteLagCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ExpressRouteLag" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ExpressRouteLags_Update", "tags": [ "ExpressRouteLags" ], "description": "Update ExpressRouteLag tags or identity.", "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": "expressRouteLagName", "in": "path", "description": "The name of ExpressRouteLag.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" }, { "name": "properties", "in": "body", "description": "Parameters supplied to update ExpressRouteLag resource tags or identity.", "required": true, "schema": { "$ref": "#/definitions/ExpressRouteLagUpdateTagsOrIdentityRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteLag" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update express route lag tags or identity": { "$ref": "./examples/ExpressRouteLagPatch.json" } } }, "delete": { "operationId": "ExpressRouteLags_Delete", "tags": [ "ExpressRouteLags" ], "description": "Deletes the specified ExpressRouteLag resource.", "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": "expressRouteLagName", "in": "path", "description": "The name of ExpressRouteLag.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete express route lag": { "$ref": "./examples/ExpressRouteLagDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteLags/{expressRouteLagName}/authorizations": { "get": { "operationId": "ExpressRouteLagAuthorizations_List", "tags": [ "ExpressRouteLagAuthorizations" ], "description": "Gets all authorizations in an express route LAG.", "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": "expressRouteLagName", "in": "path", "description": "The name of the express route LAG.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExpressRouteLagAuthorizationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List ExpressRouteLag Authorization": { "$ref": "./examples/ExpressRouteLagAuthorizationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteLags/{expressRouteLagName}/authorizations/{authorizationName}": { "get": { "operationId": "ExpressRouteLagAuthorizations_Get", "tags": [ "ExpressRouteLagAuthorizations" ], "description": "Gets the specified authorization from the specified express route LAG.", "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": "expressRouteLagName", "in": "path", "description": "The name of the express route LAG.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" }, { "name": "authorizationName", "in": "path", "description": "The authorization name, unique within the parent ExpressRoute LAG.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteLagAuthorization" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get ExpressRouteLag Authorization": { "$ref": "./examples/ExpressRouteLagAuthorizationGet.json" } } }, "put": { "operationId": "ExpressRouteLagAuthorizations_CreateOrUpdate", "tags": [ "ExpressRouteLagAuthorizations" ], "description": "Creates or updates an authorization in the specified express route LAG.", "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": "expressRouteLagName", "in": "path", "description": "The name of the express route LAG.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" }, { "name": "authorizationName", "in": "path", "description": "The authorization name, unique within the parent ExpressRoute LAG.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" }, { "name": "authorizationParameters", "in": "body", "description": "Parameters supplied to the create or update express route LAG authorization operation.", "required": true, "schema": { "$ref": "#/definitions/ExpressRouteLagAuthorization" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExpressRouteLagAuthorization" }, "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "201": { "description": "Resource 'ExpressRouteLagAuthorization' create operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteLagAuthorization" }, "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create ExpressRouteLag Authorization": { "$ref": "./examples/ExpressRouteLagAuthorizationCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "original-uri", "final-state-schema": "#/definitions/ExpressRouteLagAuthorization" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ExpressRouteLagAuthorizations_Delete", "tags": [ "ExpressRouteLagAuthorizations" ], "description": "Deletes the specified authorization from the specified express route LAG.", "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": "expressRouteLagName", "in": "path", "description": "The name of the express route LAG.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" }, { "name": "authorizationName", "in": "path", "description": "The authorization name, unique within the parent ExpressRoute LAG.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "format": "uri", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete ExpressRouteLag Authorization": { "$ref": "./examples/ExpressRouteLagAuthorizationDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteLags/{expressRouteLagName}/authorizations/{authorizationName}/listKeys": { "post": { "operationId": "ExpressRouteLagAuthorizations_ListKeys", "tags": [ "ExpressRouteLagAuthorizations" ], "description": "Gets the authorization key associated with the specified express route LAG 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": "expressRouteLagName", "in": "path", "description": "The name of the express route LAG.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" }, { "name": "authorizationName", "in": "path", "description": "The authorization name, unique within the parent ExpressRoute LAG.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/ExpressRouteAuthorizationKey" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List ExpressRouteLag Authorization Keys": { "$ref": "./examples/ExpressRouteLagAuthorizationListKeys.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteLags/{expressRouteLagName}/generateLoa": { "post": { "operationId": "ExpressRouteLags_GenerateLoa", "tags": [ "ExpressRouteLags" ], "description": "Generate a letter of authorization for the requested ExpressRouteLag resource.", "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": "expressRouteLagName", "in": "path", "description": "The name of ExpressRouteLag.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" }, { "name": "body", "in": "body", "description": "Request parameters supplied to generate a letter of authorization.", "required": true, "schema": { "$ref": "#/definitions/GenerateExpressRouteLagsLOARequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GenerateExpressRouteLagsLOAResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Generate express route lag LOA": { "$ref": "./examples/GenerateExpressRouteLagsLOA.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteLags/{expressRouteLagName}/links": { "get": { "operationId": "ExpressRouteLags_LinksList", "tags": [ "ExpressRouteLagLinks" ], "description": "Retrieve the ExpressRouteLagLink sub-resources of the specified ExpressRouteLag resource.", "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": "expressRouteLagName", "in": "path", "description": "The name of ExpressRouteLag.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteLagLinkListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List express route lag links": { "$ref": "./examples/ExpressRouteLagLinkList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteLags/{expressRouteLagName}/links/{linkName}": { "get": { "operationId": "ExpressRouteLags_LinksGet", "tags": [ "ExpressRouteLagLinks" ], "description": "Retrieves the specified ExpressRouteLagLink resource.", "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": "expressRouteLagName", "in": "path", "description": "The name of the express route LAG.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" }, { "name": "linkName", "in": "path", "description": "The name of the express route LAG link.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteLagLink" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get express route lag link": { "$ref": "./examples/ExpressRouteLagLinkGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteLags/{expressRouteLagName}/links/{linkName}/members": { "get": { "operationId": "ExpressRouteLags_MembersList", "tags": [ "ExpressRouteLagMembers" ], "description": "Retrieve the ExpressRouteLagMember sub-resources of the specified ExpressRouteLagLink resource.", "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": "expressRouteLagName", "in": "path", "description": "The name of the express route LAG.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" }, { "name": "linkName", "in": "path", "description": "The name of the express route LAG link.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteLagMemberListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List express route lag members": { "$ref": "./examples/ExpressRouteLagMemberList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteLags/{expressRouteLagName}/links/{linkName}/members/{memberName}": { "get": { "operationId": "ExpressRouteLags_MembersGet", "tags": [ "ExpressRouteLagMembers" ], "description": "Retrieves the specified ExpressRouteLagMember resource.", "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": "expressRouteLagName", "in": "path", "description": "The name of the express route LAG.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" }, { "name": "linkName", "in": "path", "description": "The name of the express route LAG link.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" }, { "name": "memberName", "in": "path", "description": "The name of the express route LAG member.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteLagMember" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get express route lag member": { "$ref": "./examples/ExpressRouteLagMemberGet.json" } } } }, "/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, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExpressRoutePortAuthorizationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List ExpressRoutePort Authorization": { "$ref": "./examples/ExpressRoutePortAuthorizationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/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, "type": "string" }, { "name": "authorizationName", "in": "path", "description": "The name of the authorization.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRoutePortAuthorization" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get ExpressRoutePort Authorization": { "$ref": "./examples/ExpressRoutePortAuthorizationGet.json" } } }, "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, "type": "string" }, { "name": "authorizationName", "in": "path", "description": "The name of the authorization.", "required": true, "type": "string" }, { "name": "authorizationParameters", "in": "body", "description": "Parameters supplied to the create or update express route port authorization operation.", "required": true, "schema": { "$ref": "#/definitions/ExpressRoutePortAuthorization" } } ], "responses": { "200": { "description": "Resource 'ExpressRoutePortAuthorization' update operation succeeded", "schema": { "$ref": "#/definitions/ExpressRoutePortAuthorization" } }, "201": { "description": "Resource 'ExpressRoutePortAuthorization' create operation succeeded", "schema": { "$ref": "#/definitions/ExpressRoutePortAuthorization" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "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 }, "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, "type": "string" }, { "name": "authorizationName", "in": "path", "description": "The name of the authorization.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "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 } }, "/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, "type": "string" }, { "name": "authorizationName", "in": "path", "description": "The name of the authorization.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/ExpressRouteAuthorizationKey" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List ExpressRoutePort Authorization Keys": { "$ref": "./examples/ExpressRoutePortAuthorizationListKeys.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters": { "get": { "operationId": "RouteFilters_ListByResourceGroup", "tags": [ "RouteFilters" ], "description": "Gets all route filters 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.", "schema": { "$ref": "#/definitions/RouteFilterListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteFilterListByResourceGroup": { "$ref": "./examples/RouteFilterListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}": { "get": { "operationId": "RouteFilters_Get", "tags": [ "RouteFilters" ], "description": "Gets the specified route filter.", "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": "routeFilterName", "in": "path", "description": "The name of the route filter.", "required": true, "type": "string" }, { "name": "$expand", "in": "query", "description": "Expands referenced express route bgp peering resources.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RouteFilter" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteFilterGet": { "$ref": "./examples/RouteFilterGet.json" } } }, "put": { "operationId": "RouteFilters_CreateOrUpdate", "tags": [ "RouteFilters" ], "description": "Creates or updates a route filter 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": "routeFilterName", "in": "path", "description": "The name of the route filter.", "required": true, "type": "string" }, { "name": "routeFilterParameters", "in": "body", "description": "Parameters supplied to the create or update route filter operation.", "required": true, "schema": { "$ref": "#/definitions/RouteFilter" } } ], "responses": { "200": { "description": "Resource 'RouteFilter' update operation succeeded", "schema": { "$ref": "#/definitions/RouteFilter" } }, "201": { "description": "Resource 'RouteFilter' create operation succeeded", "schema": { "$ref": "#/definitions/RouteFilter" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteFilterCreate": { "$ref": "./examples/RouteFilterCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/RouteFilter" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "RouteFilters_UpdateTags", "tags": [ "RouteFilters" ], "description": "Updates tags of a route filter.", "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": "routeFilterName", "in": "path", "description": "The name of the route filter.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to update route filter tags.", "required": true, "schema": { "$ref": "./common.json#/definitions/TagsObject" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RouteFilter" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update route filter tags": { "$ref": "./examples/RouteFilterUpdateTags.json" } } }, "delete": { "operationId": "RouteFilters_Delete", "tags": [ "RouteFilters" ], "description": "Deletes the specified route filter.", "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": "routeFilterName", "in": "path", "description": "The name of the route filter.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteFilterDelete": { "$ref": "./examples/RouteFilterDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules": { "get": { "operationId": "RouteFilterRules_ListByRouteFilter", "tags": [ "RouteFilterRules" ], "description": "Gets all RouteFilterRules in a route filter.", "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": "routeFilterName", "in": "path", "description": "The name of the route filter.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RouteFilterRuleListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteFilterRuleListByRouteFilter": { "$ref": "./examples/RouteFilterRuleListByRouteFilter.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}": { "get": { "operationId": "RouteFilterRules_Get", "tags": [ "RouteFilterRules" ], "description": "Gets the specified rule from a route filter.", "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": "routeFilterName", "in": "path", "description": "The name of the route filter.", "required": true, "type": "string" }, { "name": "ruleName", "in": "path", "description": "The name of the route filter rule.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RouteFilterRule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteFilterRuleGet": { "$ref": "./examples/RouteFilterRuleGet.json" } } }, "put": { "operationId": "RouteFilterRules_CreateOrUpdate", "tags": [ "RouteFilterRules" ], "description": "Creates or updates a route in the specified route filter.", "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": "routeFilterName", "in": "path", "description": "The name of the route filter.", "required": true, "type": "string" }, { "name": "ruleName", "in": "path", "description": "The name of the route filter rule.", "required": true, "type": "string" }, { "name": "routeFilterRuleParameters", "in": "body", "description": "Parameters supplied to the create or update route filter rule operation.", "required": true, "schema": { "$ref": "#/definitions/RouteFilterRule" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RouteFilterRule" } }, "201": { "description": "Resource 'RouteFilterRule' create operation succeeded", "schema": { "$ref": "#/definitions/RouteFilterRule" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteFilterRuleCreate": { "$ref": "./examples/RouteFilterRuleCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/RouteFilterRule" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "RouteFilterRules_Delete", "tags": [ "RouteFilterRules" ], "description": "Deletes the specified rule from a route filter.", "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": "routeFilterName", "in": "path", "description": "The name of the route filter.", "required": true, "type": "string" }, { "name": "ruleName", "in": "path", "description": "The name of the route filter rule.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteFilterRuleDelete": { "$ref": "./examples/RouteFilterRuleDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/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.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicyListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List resource group service endpoint policies": { "$ref": "./examples/ServiceEndpointPolicyList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/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, "type": "string" }, { "name": "$expand", "in": "query", "description": "Expands referenced resources.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get service endPoint Policy": { "$ref": "./examples/ServiceEndpointPolicyGet.json" } } }, "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, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the create or update service endpoint policy operation.", "required": true, "schema": { "$ref": "#/definitions/ServiceEndpointPolicy" } } ], "responses": { "200": { "description": "Resource 'ServiceEndpointPolicy' update operation succeeded", "schema": { "$ref": "#/definitions/ServiceEndpointPolicy" } }, "201": { "description": "Resource 'ServiceEndpointPolicy' create operation succeeded", "schema": { "$ref": "#/definitions/ServiceEndpointPolicy" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "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 }, "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, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to update service endpoint policy tags.", "required": true, "schema": { "$ref": "./common.json#/definitions/TagsObject" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update service endpoint policy tags": { "$ref": "./examples/ServiceEndpointPolicyUpdateTags.json" } } }, "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, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "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 } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions": { "get": { "operationId": "ServiceEndpointPolicyDefinitions_ListByResourceGroup", "tags": [ "ServiceEndpointPolicyDefinitions" ], "description": "Gets all service endpoint policy definitions in a service end point 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, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicyDefinitionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List service endpoint definitions in service end point policy": { "$ref": "./examples/ServiceEndpointPolicyDefinitionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions/{serviceEndpointPolicyDefinitionName}": { "get": { "operationId": "ServiceEndpointPolicyDefinitions_Get", "tags": [ "serviceEndpointPolicyDefinitions" ], "description": "Get a ServiceEndpointPolicyDefinition", "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, "type": "string" }, { "name": "serviceEndpointPolicyDefinitionName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicyDefinition" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get service endpoint definition in service endpoint policy": { "$ref": "./examples/ServiceEndpointPolicyDefinitionGet.json" } } }, "put": { "operationId": "ServiceEndpointPolicyDefinitions_CreateOrUpdate", "tags": [ "serviceEndpointPolicyDefinitions" ], "description": "Creates or updates a service endpoint policy definition in 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, "type": "string" }, { "name": "serviceEndpointPolicyDefinitionName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" }, { "name": "ServiceEndpointPolicyDefinitions", "in": "body", "description": "Parameters supplied to the create or update service endpoint policy operation.", "required": true, "schema": { "$ref": "#/definitions/ServiceEndpointPolicyDefinition" } } ], "responses": { "200": { "description": "Resource 'ServiceEndpointPolicyDefinition' update operation succeeded", "schema": { "$ref": "#/definitions/ServiceEndpointPolicyDefinition" } }, "201": { "description": "Resource 'ServiceEndpointPolicyDefinition' create operation succeeded", "schema": { "$ref": "#/definitions/ServiceEndpointPolicyDefinition" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create service endpoint policy definition": { "$ref": "./examples/ServiceEndpointPolicyDefinitionCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ServiceEndpointPolicyDefinition" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ServiceEndpointPolicyDefinitions_Delete", "tags": [ "ServiceEndpointPolicyDefinitions" ], "description": "Deletes the specified ServiceEndpoint policy definitions.", "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, "type": "string" }, { "name": "serviceEndpointPolicyDefinitionName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete service endpoint policy definitions from service endpoint policy": { "$ref": "./examples/ServiceEndpointPolicyDefinitionDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "definitions": { "AdvertisedPublicPrefixProperties": { "type": "object", "description": "Prefix properties required to perform validation using openssl signature.", "properties": { "prefix": { "type": "string", "description": "Advertised Public Prefix." }, "validationId": { "type": "string", "description": "Validation string that contains circuit peering info." }, "signature": { "type": "string", "description": "Signed string generated by encrypting validationId with a private key." }, "validationState": { "$ref": "./common.json#/definitions/AdvertisedPublicPrefixPropertiesValidationState", "description": "Advertised Public Prefix State that denotes if the prefix is validated or not.", "readOnly": true } } }, "AuthorizationListResult": { "type": "object", "description": "Paged collection of ExpressRouteCircuitAuthorization items", "properties": { "value": { "type": "array", "description": "The ExpressRouteCircuitAuthorization items on this page", "items": { "$ref": "#/definitions/ExpressRouteCircuitAuthorization" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AuthorizationPropertiesFormat": { "type": "object", "description": "Properties of ExpressRouteCircuitAuthorization.", "properties": { "authorizationKey": { "type": "string", "description": "The authorization key." }, "authorizationUseStatus": { "$ref": "./common.json#/definitions/AuthorizationUseStatus", "description": "The authorization use status." }, "connectionResourceUri": { "type": "string", "description": "The reference to the ExpressRoute connection resource using the authorization.", "readOnly": true }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the authorization resource.", "readOnly": true } } }, "BGPCommunity": { "type": "object", "description": "Contains bgp community information offered in Service Community resources.", "properties": { "serviceSupportedRegion": { "type": "string", "description": "The region which the service support. e.g. For O365, region is Global." }, "communityName": { "type": "string", "description": "The name of the bgp community. e.g. Skype." }, "communityValue": { "type": "string", "description": "The value of the bgp community. For more information: https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routing." }, "communityPrefixes": { "type": "array", "description": "The prefixes that the bgp community contains.", "items": { "type": "string" } }, "isAuthorizedToUse": { "type": "boolean", "description": "Customer is authorized to use bgp community or not." }, "serviceGroup": { "type": "string", "description": "The service group of the bgp community contains." } } }, "BgpServiceCommunity": { "type": "object", "description": "Service Community Properties.", "properties": { "properties": { "$ref": "#/definitions/BgpServiceCommunityPropertiesFormat", "description": "Properties of the BGP service community.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "./common.json#/definitions/Resource" } ] }, "BgpServiceCommunityListResult": { "type": "object", "description": "The response of a BgpServiceCommunity list operation.", "properties": { "value": { "type": "array", "description": "The BgpServiceCommunity items on this page", "items": { "$ref": "#/definitions/BgpServiceCommunity" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "BgpServiceCommunityPropertiesFormat": { "type": "object", "description": "Properties of Service Community.", "properties": { "serviceName": { "type": "string", "description": "The name of the bgp community. e.g. Skype." }, "bgpCommunities": { "type": "array", "description": "A list of bgp communities.", "items": { "$ref": "#/definitions/BGPCommunity" } } } }, "ExpressRouteCircuit": { "type": "object", "description": "ExpressRouteCircuit resource.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat", "description": "Properties of the express route circuit.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "sku": { "$ref": "#/definitions/ExpressRouteCircuitSku", "description": "The SKU." } }, "allOf": [ { "$ref": "./common.json#/definitions/Resource" } ] }, "ExpressRouteCircuitArpTable": { "type": "object", "description": "The ARP table associated with the ExpressRouteCircuit.", "properties": { "age": { "type": "integer", "format": "int32", "description": "Entry age in minutes." }, "interface": { "type": "string", "description": "Interface address." }, "ipAddress": { "type": "string", "description": "The IP address." }, "macAddress": { "type": "string", "description": "The MAC address." } } }, "ExpressRouteCircuitAuthorization": { "type": "object", "description": "Authorization in an ExpressRouteCircuit resource.", "properties": { "properties": { "$ref": "#/definitions/AuthorizationPropertiesFormat", "description": "Properties of the express route circuit authorization.", "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" } ] }, "ExpressRouteCircuitConnection": { "type": "object", "description": "Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteCircuitConnectionPropertiesFormat", "description": "Properties of the express route circuit connection.", "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" } ] }, "ExpressRouteCircuitConnectionListResult": { "type": "object", "description": "The response of a ExpressRouteCircuitConnection list operation.", "properties": { "value": { "type": "array", "description": "The ExpressRouteCircuitConnection items on this page", "items": { "$ref": "#/definitions/ExpressRouteCircuitConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteCircuitConnectionPropertiesFormat": { "type": "object", "description": "Properties of the express route circuit connection.", "properties": { "expressRouteCircuitPeering": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection." }, "peerExpressRouteCircuitPeering": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to Express Route Circuit Private Peering Resource of the peered circuit." }, "addressPrefix": { "type": "string", "description": "/29 IP address space to carve out Customer addresses for tunnels." }, "authorizationKey": { "type": "string", "description": "The authorization key." }, "ipv6CircuitConnectionConfig": { "$ref": "#/definitions/Ipv6CircuitConnectionConfig", "description": "IPv6 Address PrefixProperties of the express route circuit connection." }, "circuitConnectionStatus": { "$ref": "./common.json#/definitions/CircuitConnectionStatus", "description": "Express Route Circuit connection state.", "readOnly": true }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route circuit connection resource.", "readOnly": true } } }, "ExpressRouteCircuitListResult": { "type": "object", "description": "The response of a ExpressRouteCircuit list operation.", "properties": { "value": { "type": "array", "description": "The ExpressRouteCircuit items on this page", "items": { "$ref": "#/definitions/ExpressRouteCircuit" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteCircuitPeering": { "type": "object", "description": "Peering in an ExpressRouteCircuit resource.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat", "description": "Properties of the express route circuit peering.", "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" } ] }, "ExpressRouteCircuitPeeringConfig": { "type": "object", "description": "Specifies the peering configuration.", "properties": { "advertisedPublicPrefixes": { "type": "array", "description": "The reference to AdvertisedPublicPrefixes.", "items": { "type": "string" } }, "advertisedCommunities": { "type": "array", "description": "The communities of bgp peering. Specified for microsoft peering.", "items": { "type": "string" } }, "advertisedPublicPrefixesState": { "$ref": "./common.json#/definitions/ExpressRouteCircuitPeeringAdvertisedPublicPrefixState", "description": "The advertised public prefix state of the Peering resource.", "readOnly": true }, "legacyMode": { "type": "integer", "format": "int32", "description": "The legacy mode of the peering." }, "customerASN": { "type": "integer", "format": "int32", "description": "The CustomerASN of the peering." }, "routingRegistryName": { "type": "string", "description": "The RoutingRegistryName of the configuration." }, "advertisedPublicPrefixInfo": { "type": "array", "description": "List of Prefix information required to perform validation.", "items": { "$ref": "#/definitions/AdvertisedPublicPrefixProperties" }, "x-ms-identifiers": [] } } }, "ExpressRouteCircuitPeeringListResult": { "type": "object", "description": "The response of a ExpressRouteCircuitPeering list operation.", "properties": { "value": { "type": "array", "description": "The ExpressRouteCircuitPeering items on this page", "items": { "$ref": "#/definitions/ExpressRouteCircuitPeering" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteCircuitPeeringPropertiesFormat": { "type": "object", "description": "Properties of the express route circuit peering.", "properties": { "peeringType": { "$ref": "./common.json#/definitions/ExpressRoutePeeringType", "description": "The peering type." }, "state": { "$ref": "./common.json#/definitions/ExpressRoutePeeringState", "description": "The peering state." }, "azureASN": { "type": "integer", "format": "int32", "description": "The Azure ASN." }, "peerASN": { "type": "integer", "format": "int64", "description": "The peer ASN.", "minimum": 1, "maximum": 4294967295 }, "primaryPeerAddressPrefix": { "type": "string", "description": "The primary address prefix." }, "secondaryPeerAddressPrefix": { "type": "string", "description": "The secondary address prefix." }, "primaryAzurePort": { "type": "string", "description": "The primary port." }, "secondaryAzurePort": { "type": "string", "description": "The secondary port." }, "sharedKey": { "type": "string", "description": "The shared key." }, "vlanId": { "type": "integer", "format": "int32", "description": "The VLAN ID." }, "microsoftPeeringConfig": { "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", "description": "The Microsoft peering configuration." }, "stats": { "$ref": "#/definitions/ExpressRouteCircuitStats", "description": "The peering stats of express route circuit." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route circuit peering resource.", "readOnly": true }, "gatewayManagerEtag": { "type": "string", "description": "The GatewayManager Etag." }, "lastModifiedBy": { "type": "string", "description": "Who was the last to modify the peering.", "readOnly": true }, "routeFilter": { "$ref": "./common.json#/definitions/SubResource", "description": "The reference to the RouteFilter resource." }, "ipv6PeeringConfig": { "$ref": "#/definitions/Ipv6ExpressRouteCircuitPeeringConfig", "description": "The IPv6 peering configuration." }, "expressRouteConnection": { "$ref": "./virtualWan.json#/definitions/ExpressRouteConnectionId", "description": "The ExpressRoute connection." }, "connections": { "type": "array", "description": "The list of circuit connections associated with Azure Private Peering for this circuit.", "items": { "$ref": "#/definitions/ExpressRouteCircuitConnection" } }, "peeredConnections": { "type": "array", "description": "The list of peered circuit connections associated with Azure Private Peering for this circuit.", "items": { "$ref": "#/definitions/PeerExpressRouteCircuitConnection" }, "readOnly": true } } }, "ExpressRouteCircuitPropertiesFormat": { "type": "object", "description": "Properties of ExpressRouteCircuit.", "properties": { "allowClassicOperations": { "type": "boolean", "description": "Allow classic operations." }, "circuitProvisioningState": { "type": "string", "description": "The CircuitProvisioningState state of the resource." }, "serviceProviderProvisioningState": { "$ref": "./common.json#/definitions/ServiceProviderProvisioningState", "description": "The ServiceProviderProvisioningState state of the resource." }, "authorizations": { "type": "array", "description": "The list of authorizations.", "items": { "$ref": "#/definitions/ExpressRouteCircuitAuthorization" } }, "peerings": { "type": "array", "description": "The list of peerings.", "items": { "$ref": "#/definitions/ExpressRouteCircuitPeering" } }, "serviceKey": { "type": "string", "description": "The ServiceKey." }, "serviceProviderNotes": { "type": "string", "description": "The ServiceProviderNotes." }, "serviceProviderProperties": { "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties", "description": "The ServiceProviderProperties." }, "expressRoutePort": { "$ref": "./common.json#/definitions/SubResource", "description": "The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource." }, "expressRouteLag": { "$ref": "./common.json#/definitions/SubResource", "description": "The reference to the ExpressRouteLag resource when the circuit is provisioned on an ExpressRouteLag resource." }, "bandwidthInGbps": { "type": "number", "format": "float", "description": "The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource." }, "stag": { "type": "integer", "format": "int32", "description": "The identifier of the circuit traffic. Outer tag for QinQ encapsulation.", "readOnly": true }, "resiliencyLevel": { "$ref": "./common.json#/definitions/ResiliencyLevel", "description": "The resiliency level of the ExpressRoute circuit.", "readOnly": true }, "partnerAccountId": { "type": "string", "description": "Account ID of customer account on partner cloud provider." }, "activationKey": { "type": "string", "description": "Activation Key from partner cloud provider." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route circuit resource.", "readOnly": true }, "gatewayManagerEtag": { "type": "string", "description": "The GatewayManager Etag." }, "globalReachEnabled": { "type": "boolean", "description": "Flag denoting global reach status." }, "authorizationKey": { "type": "string", "description": "The authorizationKey." }, "authorizationStatus": { "type": "string", "description": "The authorization status of the Circuit.", "readOnly": true }, "enableDirectPortRateLimit": { "type": "boolean", "description": "Flag denoting rate-limiting status of the ExpressRoute direct-port circuit." } } }, "ExpressRouteCircuitReference": { "type": "object", "description": "Reference to an express route circuit.", "properties": { "id": { "type": "string", "description": "Corresponding Express Route Circuit Id." } } }, "ExpressRouteCircuitRoutesTable": { "type": "object", "description": "The routes table associated with the ExpressRouteCircuit.", "properties": { "network": { "type": "string", "description": "IP address of a network entity." }, "nextHop": { "type": "string", "description": "NextHop address." }, "locPrf": { "type": "string", "description": "Local preference value as set with the set local-preference route-map configuration command." }, "weight": { "type": "integer", "format": "int32", "description": "Route Weight." }, "path": { "type": "string", "description": "Autonomous system paths to the destination network." } } }, "ExpressRouteCircuitRoutesTableSummary": { "type": "object", "description": "The routes table associated with the ExpressRouteCircuit.", "properties": { "neighbor": { "type": "string", "description": "IP address of the neighbor." }, "v": { "type": "integer", "format": "int32", "description": "BGP version number spoken to the neighbor." }, "as": { "type": "integer", "format": "int32", "description": "Autonomous system number." }, "upDown": { "type": "string", "description": "The length of time that the BGP session has been in the Established state, or the current status if not in the Established state." }, "statePfxRcd": { "type": "string", "description": "Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group." } } }, "ExpressRouteCircuitServiceProviderProperties": { "type": "object", "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit.", "properties": { "serviceProviderName": { "type": "string", "description": "The serviceProviderName." }, "peeringLocation": { "type": "string", "description": "The peering location." }, "bandwidthInMbps": { "type": "integer", "format": "int32", "description": "The BandwidthInMbps." } } }, "ExpressRouteCircuitSku": { "type": "object", "description": "Contains SKU in an ExpressRouteCircuit.", "properties": { "name": { "type": "string", "description": "The name of the SKU." }, "tier": { "$ref": "./common.json#/definitions/ExpressRouteCircuitSkuTier", "description": "The tier of the SKU." }, "family": { "$ref": "./common.json#/definitions/ExpressRouteCircuitSkuFamily", "description": "The family of the SKU." } } }, "ExpressRouteCircuitStats": { "type": "object", "description": "Contains stats associated with the peering.", "properties": { "primarybytesIn": { "type": "integer", "format": "int64", "description": "The Primary BytesIn of the peering." }, "primarybytesOut": { "type": "integer", "format": "int64", "description": "The primary BytesOut of the peering." }, "secondarybytesIn": { "type": "integer", "format": "int64", "description": "The secondary BytesIn of the peering." }, "secondarybytesOut": { "type": "integer", "format": "int64", "description": "The secondary BytesOut of the peering." } } }, "ExpressRouteCircuitsArpTableListResult": { "type": "object", "description": "Response for ListArpTable associated with the Express Route Circuits API.", "properties": { "value": { "type": "array", "description": "The ExpressRouteCircuitArpTable items on this page", "items": { "$ref": "#/definitions/ExpressRouteCircuitArpTable" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteCircuitsRoutesTableListResult": { "type": "object", "description": "Response for ListRoutesTable associated with the Express Route Circuits API.", "properties": { "value": { "type": "array", "description": "The ExpressRouteCircuitRoutesTable items on this page", "items": { "$ref": "#/definitions/ExpressRouteCircuitRoutesTable" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteCircuitsRoutesTableSummaryListResult": { "type": "object", "description": "Response for ListRoutesTable associated with the Express Route Circuits API.", "properties": { "value": { "type": "array", "description": "The ExpressRouteCircuitRoutesTableSummary items on this page", "items": { "$ref": "#/definitions/ExpressRouteCircuitRoutesTableSummary" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteCrossConnection": { "type": "object", "description": "ExpressRouteCrossConnection resource.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteCrossConnectionProperties", "description": "Properties of the express route cross connection.", "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/Resource" } ] }, "ExpressRouteCrossConnectionListResult": { "type": "object", "description": "The response of a ExpressRouteCrossConnection list operation.", "properties": { "value": { "type": "array", "description": "The ExpressRouteCrossConnection items on this page", "items": { "$ref": "#/definitions/ExpressRouteCrossConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteCrossConnectionPeering": { "type": "object", "description": "Peering in an ExpressRoute Cross Connection resource.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringProperties", "description": "Properties of the express route cross connection peering.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ExpressRouteCrossConnectionPeeringList": { "type": "object", "description": "Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCrossConnection.", "properties": { "value": { "type": "array", "description": "The ExpressRouteCrossConnectionPeering items on this page", "items": { "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteCrossConnectionPeeringProperties": { "type": "object", "description": "Properties of express route cross connection peering.", "properties": { "peeringType": { "$ref": "./common.json#/definitions/ExpressRoutePeeringType", "description": "The peering type." }, "state": { "$ref": "./common.json#/definitions/ExpressRoutePeeringState", "description": "The peering state." }, "azureASN": { "type": "integer", "format": "int32", "description": "The Azure ASN.", "readOnly": true }, "peerASN": { "type": "integer", "format": "int64", "description": "The peer ASN.", "minimum": 1, "maximum": 4294967295 }, "primaryPeerAddressPrefix": { "type": "string", "description": "The primary address prefix." }, "secondaryPeerAddressPrefix": { "type": "string", "description": "The secondary address prefix." }, "primaryAzurePort": { "type": "string", "description": "The primary port.", "readOnly": true }, "secondaryAzurePort": { "type": "string", "description": "The secondary port.", "readOnly": true }, "sharedKey": { "type": "string", "description": "The shared key." }, "vlanId": { "type": "integer", "format": "int32", "description": "The VLAN ID." }, "microsoftPeeringConfig": { "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", "description": "The Microsoft peering configuration." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route cross connection peering resource.", "readOnly": true }, "gatewayManagerEtag": { "type": "string", "description": "The GatewayManager Etag." }, "lastModifiedBy": { "type": "string", "description": "Who was the last to modify the peering.", "readOnly": true }, "ipv6PeeringConfig": { "$ref": "#/definitions/Ipv6ExpressRouteCircuitPeeringConfig", "description": "The IPv6 peering configuration." } } }, "ExpressRouteCrossConnectionProperties": { "type": "object", "description": "Properties of ExpressRouteCrossConnection.", "properties": { "primaryAzurePort": { "type": "string", "description": "The name of the primary port.", "readOnly": true }, "secondaryAzurePort": { "type": "string", "description": "The name of the secondary port.", "readOnly": true }, "sTag": { "type": "integer", "format": "int32", "description": "The identifier of the circuit traffic.", "readOnly": true }, "peeringLocation": { "type": "string", "description": "The peering location of the ExpressRoute circuit.", "readOnly": true }, "bandwidthInMbps": { "type": "integer", "format": "int32", "description": "The circuit bandwidth In Mbps.", "readOnly": true }, "expressRouteCircuit": { "$ref": "#/definitions/ExpressRouteCircuitReference", "description": "The ExpressRouteCircuit." }, "serviceProviderProvisioningState": { "$ref": "./common.json#/definitions/ServiceProviderProvisioningState", "description": "The provisioning state of the circuit in the connectivity provider system." }, "serviceProviderNotes": { "type": "string", "description": "Additional read only notes set by the connectivity provider." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route cross connection resource.", "readOnly": true }, "peerings": { "type": "array", "description": "The list of peerings.", "items": { "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" } } } }, "ExpressRouteCrossConnectionRoutesTableSummary": { "type": "object", "description": "The routes table associated with the ExpressRouteCircuit.", "properties": { "neighbor": { "type": "string", "description": "IP address of Neighbor router." }, "asn": { "type": "integer", "format": "int32", "description": "Autonomous system number." }, "upDown": { "type": "string", "description": "The length of time that the BGP session has been in the Established state, or the current status if not in the Established state." }, "stateOrPrefixesReceived": { "type": "string", "description": "Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group." } } }, "ExpressRouteCrossConnectionsRoutesTableSummaryListResult": { "type": "object", "description": "Response for ListRoutesTable associated with the Express Route Cross Connections.", "properties": { "value": { "type": "array", "description": "The ExpressRouteCrossConnectionRoutesTableSummary items on this page", "items": { "$ref": "#/definitions/ExpressRouteCrossConnectionRoutesTableSummary" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items", "readOnly": true } }, "required": [ "value" ] }, "ExpressRouteLag": { "type": "object", "title": "ExpressRoute LAG", "description": "ExpressRouteLag resource definition.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteLagPropertiesFormat", "description": "ExpressRouteLag properties." }, "id": { "type": "string", "description": "The unique identifier of the resource.", "readOnly": true }, "type": { "type": "string", "description": "The type of the resource.", "readOnly": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "identity": { "$ref": "./common.json#/definitions/ManagedServiceIdentity", "description": "The identity of ExpressRouteLag, if configured." } }, "allOf": [ { "$ref": "./common.json#/definitions/Resource" } ] }, "ExpressRouteLagAuthorization": { "type": "object", "title": "ExpressRoute Lag Authorization", "description": "ExpressRouteLag Authorization resource definition.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteLagAuthorizationPropertiesFormat", "description": "ExpressRouteLag authorization properties." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/ProxyResourceWithReadOnlyID" } ] }, "ExpressRouteLagAuthorizationListResult": { "type": "object", "title": "ExpressRoute Lag Authorization List Result", "description": "Paged collection of ExpressRouteLagAuthorization items", "properties": { "value": { "type": "array", "description": "The ExpressRouteLagAuthorization items on this page", "items": { "$ref": "#/definitions/ExpressRouteLagAuthorization" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteLagAuthorizationPropertiesFormat": { "type": "object", "title": "ExpressRoute Lag Authorization Properties", "description": "Properties of ExpressRouteLag Authorization.", "properties": { "authorizationUseStatus": { "$ref": "./common.json#/definitions/ExpressRouteLagAuthorizationUseStatus", "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 } } }, "ExpressRouteLagLink": { "type": "object", "title": "ExpressRouteLagLink", "description": "ExpressRouteLagLink child resource definition.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteLagLinkPropertiesFormat", "description": "ExpressRouteLagLink properties." }, "id": { "type": "string", "description": "The unique identifier of the resource.", "readOnly": true }, "type": { "type": "string", "description": "The type of the resource.", "readOnly": true }, "name": { "type": "string", "description": "Name of child link resource that is unique among child link resources of the parent.", "readOnly": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "required": [ "id", "type", "name" ], "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ExpressRouteLagLinkListResult": { "type": "object", "title": "ExpressRoute LAG Link List Result", "description": "Paged collection of ExpressRouteLagLink items", "properties": { "value": { "type": "array", "description": "The ExpressRouteLagLink items on this page", "items": { "$ref": "#/definitions/ExpressRouteLagLink" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteLagLinkPropertiesFormat": { "type": "object", "title": "ExpressRouteLagLink Resource Properties", "description": "Properties specific to ExpressRouteLagLink resources.", "properties": { "routerName": { "type": "string", "description": "Name of Azure router associated with link.", "readOnly": true }, "interfaceName": { "type": "string", "description": "Name of Azure router interface.", "readOnly": true }, "adminState": { "$ref": "./common.json#/definitions/ExpressRouteLinkAdminState", "description": "Administrative state of the link." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route LAG link resource.", "readOnly": true }, "macSecConfig": { "$ref": "#/definitions/ExpressRouteLinkMacSecConfig", "description": "MacSec configuration." }, "members": { "type": "array", "title": "ExpressRouteLagMember Sub-Resources", "description": "The set of members of the ExpressRouteLagLink resource.", "items": { "$ref": "#/definitions/ExpressRouteLagMember" } } } }, "ExpressRouteLagListResult": { "type": "object", "title": "ExpressRoute LAG List Result", "description": "Paged collection of ExpressRouteLag items", "properties": { "value": { "type": "array", "description": "The ExpressRouteLag items on this page", "items": { "$ref": "#/definitions/ExpressRouteLag" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteLagMember": { "type": "object", "title": "ExpressRouteLagMember", "description": "ExpressRouteLagMember child resource definition.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteLagMemberPropertiesFormat", "description": "ExpressRouteLagMember properties." }, "id": { "type": "string", "description": "The unique identifier of the resource.", "readOnly": true }, "type": { "type": "string", "description": "The type of the resource.", "readOnly": true }, "name": { "type": "string", "description": "Name of child member resource that is unique among child member resources of the parent.", "readOnly": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "required": [ "id", "type", "name" ], "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ExpressRouteLagMemberListResult": { "type": "object", "title": "ExpressRoute LAG Member List Result", "description": "Paged collection of ExpressRouteLagMember items", "properties": { "value": { "type": "array", "description": "The ExpressRouteLagMember items on this page", "items": { "$ref": "#/definitions/ExpressRouteLagMember" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteLagMemberPropertiesFormat": { "type": "object", "title": "ExpressRouteLagMember Resource Properties", "description": "Properties specific to ExpressRouteLagMember resources.", "properties": { "interfaceName": { "type": "string", "description": "Name of Azure router interface.", "readOnly": true }, "patchPanelId": { "type": "string", "description": "Mapping between physical port to patch panel port.", "readOnly": true }, "rackId": { "type": "string", "description": "Mapping of physical patch panel to rack.", "readOnly": true }, "coloLocation": { "type": "string", "description": "Cololocation for ExpressRoute member.", "readOnly": true }, "connectorType": { "$ref": "./common.json#/definitions/ExpressRouteLinkConnectorType", "description": "Physical fiber port type.", "readOnly": true }, "adminState": { "$ref": "./common.json#/definitions/ExpressRouteLinkAdminState", "description": "Administrative state of the member port." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route LAG member resource.", "readOnly": true } } }, "ExpressRouteLagPropertiesFormat": { "type": "object", "title": "ExpressRouteLag Resource Properties", "description": "Properties specific to ExpressRouteLag resources.", "properties": { "peeringLocation": { "type": "string", "description": "The name of the peering location that the ExpressRouteLag is mapped to physically." }, "bandwidthInGbps": { "type": "integer", "format": "int32", "description": "Bandwidth of procured LAG in Gbps." }, "provisionedBandwidthInGbps": { "type": "number", "format": "double", "description": "Aggregate Gbps of associated circuit bandwidths.", "readOnly": true }, "mtu": { "type": "string", "description": "Maximum transmission unit of the LAG.", "readOnly": true }, "encapsulation": { "$ref": "./common.json#/definitions/ExpressRouteLagEncapsulation", "description": "Encapsulation method on LAG." }, "etherType": { "type": "string", "description": "Ether type of the LAG.", "readOnly": true }, "links": { "type": "array", "title": "ExpressRouteLagLink Sub-Resources", "description": "The set of links of the ExpressRouteLag resource.", "items": { "$ref": "#/definitions/ExpressRouteLagLink" } }, "circuits": { "type": "array", "description": "Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRouteLag resource.", "items": { "$ref": "./common.json#/definitions/SubResource" }, "readOnly": true }, "authorizations": { "type": "array", "title": "ExpressRouteLagAuthorizations Child-Resources", "description": "The set of authorizations of the ExpressRouteLag resource.", "items": { "$ref": "#/definitions/ExpressRouteLagAuthorization" } }, "allocationDate": { "type": "string", "description": "The date and time when the ExpressRouteLag was allocated.", "readOnly": true }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route LAG resource.", "readOnly": true }, "resourceGuid": { "type": "string", "description": "The resource GUID property of the express route LAG resource.", "readOnly": true }, "billingType": { "$ref": "./common.json#/definitions/ExpressRouteLagBillingType", "description": "The billing type of the ExpressRouteLag resource." }, "numberOfPorts": { "type": "integer", "format": "int32", "description": "Number of ports in the LAG.", "minimum": 1 }, "minimumActivePortsRequired": { "type": "integer", "format": "int32", "description": "Minimum number of active ports required for LAG.", "minimum": 1 }, "lacpTimer": { "$ref": "./common.json#/definitions/ExpressRouteLagLacpTimer", "description": "LACP timer configuration." } } }, "ExpressRouteLagUpdateTagsOrIdentityRequest": { "type": "object", "title": "ExpressRouteLag Update Tags or Identity Request", "description": "Parameters for updating ExpressRouteLag tags or identity.", "properties": { "identity": { "$ref": "./common.json#/definitions/ManagedServiceIdentity", "description": "The identity of ExpressRouteLag, if configured." }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } }, "ExpressRouteLink": { "type": "object", "title": "ExpressRouteLink", "description": "ExpressRouteLink child resource definition.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteLinkPropertiesFormat", "description": "ExpressRouteLink properties.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of child port resource that is unique among child port resources of the parent." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ExpressRouteLinkFailoverAllTestsDetails": { "type": "object", "description": "ExpressRoute circuit link failover test details for all tests.", "properties": { "status": { "$ref": "./common.json#/definitions/FailoverTestStatus", "description": "The current status of the test." }, "startTime": { "type": "string", "description": "Time when the test was started." }, "endTime": { "type": "string", "description": "Time when the test was completed." }, "testGuid": { "type": "string", "description": "The unique GUID associated with the test." }, "testType": { "$ref": "./common.json#/definitions/FailoverTestType", "description": "The type of failover test." }, "issues": { "type": "array", "description": "A list of all issues with the test.", "items": { "type": "string" } }, "wasSimulationSuccessful": { "type": "boolean", "description": "Whether the failover simulation was successful or not." }, "circuitTestCategory": { "$ref": "./common.json#/definitions/MaintenanceTestCategory", "description": "The maintenance test category." }, "linkType": { "$ref": "./common.json#/definitions/ExpressRouteFailoverLinkType", "description": "The link type." }, "bgpStatus": { "type": "array", "description": "The BGP status details.", "items": { "$ref": "#/definitions/ExpressRouteLinkFailoverTestBgpStatus" } } } }, "ExpressRouteLinkFailoverAllTestsDetailsArray": { "type": "array", "items": { "$ref": "#/definitions/ExpressRouteLinkFailoverAllTestsDetails" } }, "ExpressRouteLinkFailoverRoute": { "type": "object", "description": "Represents a failover route for an ExpressRoute link.", "properties": { "route": { "type": "string", "description": "The route." }, "nextHop": { "type": "string", "description": "The next hop." }, "primaryASPath": { "type": "string", "description": "The AS path for primary link." }, "secondaryASPath": { "type": "string", "description": "The AS path for secondary link." } } }, "ExpressRouteLinkFailoverRouteList": { "type": "object", "description": "Represents a list of failover routes for an ExpressRoute link.", "properties": { "beforeSimulation": { "type": "array", "description": "The routes before the simulation.", "items": { "$ref": "#/definitions/ExpressRouteLinkFailoverRoute" } }, "duringSimulation": { "type": "array", "description": "The routes during the simulation.", "items": { "$ref": "#/definitions/ExpressRouteLinkFailoverRoute" } } } }, "ExpressRouteLinkFailoverSingleTestDetails": { "type": "object", "description": "ExpressRoute circuit link failover single test details.", "properties": { "startTimeUtc": { "type": "string", "description": "Time when the test was started in UTC." }, "endTimeUtc": { "type": "string", "description": "Time when the test was completed in UTC." }, "status": { "$ref": "./common.json#/definitions/FailoverTestStatus", "description": "The current status of the test." }, "wasSimulationSuccessful": { "type": "boolean", "description": "Whether the failover simulation was successful or not." }, "linkType": { "$ref": "./common.json#/definitions/ExpressRouteFailoverLinkType", "description": "The link type." }, "circuitTestCategory": { "$ref": "./common.json#/definitions/MaintenanceTestCategory", "description": "The circuit test category." }, "isSimulationVerified": { "type": "boolean", "description": "Whether the simulation was verified." }, "redundantRoutes": { "$ref": "#/definitions/ExpressRouteLinkFailoverRouteList", "description": "The redundant routes for link failover tests." }, "nonRedundantRoutes": { "$ref": "#/definitions/ExpressRouteLinkFailoverRouteList", "description": "The non-redundant routes for link failover tests." }, "bgpStatus": { "type": "array", "description": "The BGP status details.", "items": { "$ref": "#/definitions/ExpressRouteLinkFailoverTestBgpStatus" } } } }, "ExpressRouteLinkFailoverSingleTestDetailsArray": { "type": "array", "items": { "$ref": "#/definitions/ExpressRouteLinkFailoverSingleTestDetails" } }, "ExpressRouteLinkFailoverStopApiParameters": { "type": "object", "description": "Parameters for stopping an ExpressRoute circuit link failover test.", "properties": { "circuitTestCategory": { "type": "string", "description": "The category of the circuit test." }, "linkType": { "type": "string", "description": "The type of the link." }, "wasSimulationSuccessful": { "type": "boolean", "description": "Whether the simulation was successful." }, "isVerified": { "type": "boolean", "description": "Whether the link is verified." } } }, "ExpressRouteLinkFailoverTestBgpStatus": { "type": "object", "description": "Represents the BGP status of an ExpressRoute link failover test.", "properties": { "type": { "$ref": "./common.json#/definitions/ExpressRouteFailoverBgpStatusAddressFamily", "description": "The address family type." }, "link": { "$ref": "./common.json#/definitions/ExpressRouteFailoverLinkType", "description": "The link type." }, "status": { "$ref": "./common.json#/definitions/ExpressRouteLinkFailoverBgpStatus", "description": "The BGP status." }, "checkTimeUtc": { "type": "string", "description": "The check time in UTC." } } }, "ExpressRouteLinkListResult": { "type": "object", "title": "ExpressRouteLink List Result", "description": "Response for ListExpressRouteLinks API service call.", "properties": { "value": { "type": "array", "description": "The ExpressRouteLink items on this page", "items": { "$ref": "#/definitions/ExpressRouteLink" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteLinkMacSecConfig": { "type": "object", "title": "Definition of ExpressRouteLink Mac Security configuration.", "description": "ExpressRouteLink Mac Security Configuration.", "properties": { "cknSecretIdentifier": { "type": "string", "description": "Keyvault Secret Identifier URL containing Mac security CKN key." }, "cakSecretIdentifier": { "type": "string", "description": "Keyvault Secret Identifier URL containing Mac security CAK key." }, "cipher": { "$ref": "./common.json#/definitions/ExpressRouteLinkMacSecCipher", "description": "Mac security cipher." }, "sciState": { "$ref": "./common.json#/definitions/ExpressRouteLinkMacSecSciState", "description": "Sci mode enabled/disabled." } } }, "ExpressRouteLinkPropertiesFormat": { "type": "object", "title": "ExpressRouteLink Resource Properties", "description": "Properties specific to ExpressRouteLink resources.", "properties": { "routerName": { "type": "string", "description": "Name of Azure router associated with physical port.", "readOnly": true }, "interfaceName": { "type": "string", "description": "Name of Azure router interface.", "readOnly": true }, "patchPanelId": { "type": "string", "description": "Mapping between physical port to patch panel port.", "readOnly": true }, "rackId": { "type": "string", "description": "Mapping of physical patch panel to rack.", "readOnly": true }, "coloLocation": { "type": "string", "description": "Cololocation for ExpressRoute Hybrid Direct.", "readOnly": true }, "connectorType": { "$ref": "./common.json#/definitions/ExpressRouteLinkConnectorType", "description": "Physical fiber port type.", "readOnly": true }, "adminState": { "$ref": "./common.json#/definitions/ExpressRouteLinkAdminState", "description": "Administrative state of the physical port." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route link resource.", "readOnly": true }, "macSecConfig": { "$ref": "#/definitions/ExpressRouteLinkMacSecConfig", "description": "MacSec configuration." } } }, "ExpressRoutePort": { "type": "object", "title": "ExpressRoute Port", "description": "ExpressRoutePort resource definition.", "properties": { "properties": { "$ref": "#/definitions/ExpressRoutePortPropertiesFormat", "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 }, "identity": { "$ref": "./common.json#/definitions/ManagedServiceIdentity", "description": "The identity of ExpressRoutePort, if configured." } }, "allOf": [ { "$ref": "./common.json#/definitions/Resource" } ] }, "ExpressRoutePortAuthorization": { "type": "object", "title": "ExpressRoute Port Authorization", "description": "ExpressRoutePort Authorization resource definition.", "properties": { "properties": { "$ref": "#/definitions/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" } ] }, "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": "#/definitions/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 } } }, "ExpressRoutePortListResult": { "type": "object", "title": "ExpressRoute Port List Result", "description": "Paged collection of ExpressRoutePort items", "properties": { "value": { "type": "array", "description": "The ExpressRoutePort items on this page", "items": { "$ref": "#/definitions/ExpressRoutePort" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRoutePortPropertiesFormat": { "type": "object", "title": "ExpressRoutePort Properties", "description": "Properties specific to ExpressRoutePort resources.", "properties": { "peeringLocation": { "type": "string", "description": "The name of the peering location that the ExpressRoutePort is mapped to physically." }, "bandwidthInGbps": { "type": "integer", "format": "int32", "description": "Bandwidth of procured ports in Gbps." }, "provisionedBandwidthInGbps": { "type": "number", "format": "float", "description": "Aggregate Gbps of associated circuit bandwidths.", "readOnly": true }, "mtu": { "type": "string", "description": "Maximum transmission unit of the physical port pair(s).", "readOnly": true }, "encapsulation": { "$ref": "./common.json#/definitions/ExpressRoutePortsEncapsulation", "description": "Encapsulation method on physical ports." }, "etherType": { "type": "string", "description": "Ether type of the physical port.", "readOnly": true }, "allocationDate": { "type": "string", "description": "Date of the physical port allocation to be used in Letter of Authorization.", "readOnly": true }, "links": { "type": "array", "title": "ExpressRouteLink Sub-Resources", "description": "The set of physical links of the ExpressRoutePort resource.", "items": { "$ref": "#/definitions/ExpressRouteLink" } }, "circuits": { "type": "array", "description": "Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource.", "items": { "$ref": "./common.json#/definitions/SubResource" }, "readOnly": true }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route port resource.", "readOnly": true }, "resourceGuid": { "type": "string", "description": "The resource GUID property of the express route port resource.", "readOnly": true }, "billingType": { "$ref": "./common.json#/definitions/ExpressRoutePortsBillingType", "description": "The billing type of the ExpressRoutePort resource." } } }, "ExpressRoutePortsLocation": { "type": "object", "title": "ExpressRoutePorts Peering Location", "description": "Definition of the ExpressRoutePorts peering location resource.", "properties": { "properties": { "$ref": "#/definitions/ExpressRoutePortsLocationPropertiesFormat", "description": "ExpressRoutePort peering location properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "./common.json#/definitions/Resource" } ] }, "ExpressRoutePortsLocationBandwidths": { "type": "object", "title": "ExpressRoutePorts Location Bandwidths", "description": "Real-time inventory of available ExpressRoute port bandwidths.", "properties": { "offerName": { "type": "string", "description": "Bandwidth descriptive name.", "readOnly": true }, "valueInGbps": { "type": "integer", "format": "int32", "description": "Bandwidth value in Gbps.", "readOnly": true } } }, "ExpressRoutePortsLocationListResult": { "type": "object", "title": "ExpressRoutePorts Location List Result", "description": "Paged collection of ExpressRoutePortsLocation items", "properties": { "value": { "type": "array", "description": "The ExpressRoutePortsLocation items on this page", "items": { "$ref": "#/definitions/ExpressRoutePortsLocation" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRoutePortsLocationPropertiesFormat": { "type": "object", "title": "ExpressRoutePorts Location Properties", "description": "Properties specific to ExpressRoutePorts peering location resources.", "properties": { "address": { "type": "string", "description": "Address of peering location.", "readOnly": true }, "contact": { "type": "string", "description": "Contact details of peering locations.", "readOnly": true }, "availableBandwidths": { "type": "array", "description": "The inventory of available ExpressRoutePort bandwidths.", "items": { "$ref": "#/definitions/ExpressRoutePortsLocationBandwidths" } }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route port location resource.", "readOnly": true } } }, "ExpressRouteProviderPort": { "type": "object", "description": "ExpressRouteProviderPort resource.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteProviderPortProperties", "description": "Properties of the express route Service Provider Port.", "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/TrackedResourceWithOptionalLocation" } ] }, "ExpressRouteProviderPortListResult": { "type": "object", "description": "Response for ListExpressRouteProviderPort API service call.", "properties": { "value": { "type": "array", "description": "The ExpressRouteProviderPort items on this page", "items": { "$ref": "#/definitions/ExpressRouteProviderPort" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items", "readOnly": true } }, "required": [ "value" ] }, "ExpressRouteProviderPortProperties": { "type": "object", "description": "Properties of ExpressRouteProviderPort.", "properties": { "portPairDescriptor": { "type": "string", "description": "The name of the port pair.", "readOnly": true }, "primaryAzurePort": { "type": "string", "description": "The name of the primary port.", "readOnly": true }, "secondaryAzurePort": { "type": "string", "description": "The name of the secondary port.", "readOnly": true }, "peeringLocation": { "type": "string", "description": "The peering location of the port pair." }, "overprovisionFactor": { "type": "integer", "format": "int32", "description": "Overprovisioning factor for the port pair." }, "portBandwidthInMbps": { "type": "integer", "format": "int32", "description": "Bandwidth of the port in Mbps" }, "usedBandwidthInMbps": { "type": "integer", "format": "int32", "description": "Used Bandwidth of the port in Mbps" }, "remainingBandwidthInMbps": { "type": "integer", "format": "int32", "description": "Remaining Bandwidth of the port in Mbps" } } }, "ExpressRouteServiceProvider": { "type": "object", "description": "A ExpressRouteResourceProvider object.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteServiceProviderPropertiesFormat", "description": "Properties of the express route service provider.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "./common.json#/definitions/Resource" } ] }, "ExpressRouteServiceProviderBandwidthsOffered": { "type": "object", "description": "Contains bandwidths offered in ExpressRouteServiceProvider resources.", "properties": { "offerName": { "type": "string", "description": "The OfferName." }, "valueInMbps": { "type": "integer", "format": "int32", "description": "The ValueInMbps." } } }, "ExpressRouteServiceProviderListResult": { "type": "object", "description": "The response of a ExpressRouteServiceProvider list operation.", "properties": { "value": { "type": "array", "description": "The ExpressRouteServiceProvider items on this page", "items": { "$ref": "#/definitions/ExpressRouteServiceProvider" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExpressRouteServiceProviderPropertiesFormat": { "type": "object", "description": "Properties of ExpressRouteServiceProvider.", "properties": { "peeringLocations": { "type": "array", "description": "A list of peering locations.", "items": { "type": "string" } }, "bandwidthsOffered": { "type": "array", "description": "A list of bandwidths offered.", "items": { "$ref": "#/definitions/ExpressRouteServiceProviderBandwidthsOffered" } }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route service provider resource.", "readOnly": true } } }, "GenerateExpressRouteLagsLOARequest": { "type": "object", "description": "The customer name to be printed on a letter of authorization for ExpressRouteLag.", "properties": { "customerName": { "type": "string", "description": "The customer name." }, "members": { "type": "array", "description": "The list of member names for which LOA should be generated.", "items": { "type": "string" } } }, "required": [ "customerName" ] }, "GenerateExpressRouteLagsLOAResult": { "type": "object", "description": "Response for GenerateExpressRouteLagsLOA API service call.", "properties": { "encodedContent": { "type": "string", "description": "The content as a base64 encoded string." } } }, "GenerateExpressRoutePortsLOARequest": { "type": "object", "description": "The customer name to be printed on a letter of authorization.", "properties": { "customerName": { "type": "string", "description": "The customer name." } }, "required": [ "customerName" ] }, "GenerateExpressRoutePortsLOAResult": { "type": "object", "description": "Response for GenerateExpressRoutePortsLOA API service call.", "properties": { "encodedContent": { "type": "string", "description": "The content as a base64 encoded string." } } }, "Ipv6CircuitConnectionConfig": { "type": "object", "description": "IPv6 Circuit Connection properties for global reach.", "properties": { "addressPrefix": { "type": "string", "description": "/125 IP address space to carve out customer addresses for global reach." }, "circuitConnectionStatus": { "$ref": "./common.json#/definitions/CircuitConnectionStatus", "description": "Express Route Circuit connection state.", "readOnly": true } } }, "Ipv6ExpressRouteCircuitPeeringConfig": { "type": "object", "description": "Contains IPv6 peering config.", "properties": { "primaryPeerAddressPrefix": { "type": "string", "description": "The primary address prefix." }, "secondaryPeerAddressPrefix": { "type": "string", "description": "The secondary address prefix." }, "microsoftPeeringConfig": { "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", "description": "The Microsoft peering configuration." }, "routeFilter": { "$ref": "./common.json#/definitions/SubResource", "description": "The reference to the RouteFilter resource." }, "state": { "$ref": "./common.json#/definitions/ExpressRouteCircuitPeeringState", "description": "The state of peering." } } }, "Metric": { "type": "object", "description": "Metric entry for migration peering statistics.", "properties": { "name": { "type": "string", "description": "The metric name." }, "value": { "type": "number", "format": "double", "description": "The metric value." }, "unit": { "type": "string", "description": "The metric unit." } } }, "MigrateExpressRouteCircuitHealthCheckDetails": { "type": "object", "description": "Detailed migration health information.", "properties": { "portMigrationInfos": { "type": "array", "description": "Per-port migration details.", "items": { "$ref": "#/definitions/PortMigrationInfo" }, "x-ms-identifiers": [ "portId" ] } } }, "MigrateExpressRouteCircuitHealthCheckResponse": { "type": "object", "description": "Response for express route circuit migration health check and migration operations.", "properties": { "status": { "type": "string", "description": "The overall status of the migration operation." }, "phase": { "type": "string", "description": "The current phase of the migration operation." }, "failureReason": { "type": "string", "description": "The failure reason if the migration operation failed." }, "newSTag": { "type": "string", "description": "The new service tag assigned after migration." }, "preparedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the migration was prepared." }, "prepareExpiryTime": { "type": "string", "format": "date-time", "description": "The expiry time for the prepare phase." }, "newCrossConnectionUrl": { "type": "string", "format": "uri", "description": "The URL of the new cross connection after migration." }, "shouldRollback": { "type": "boolean", "description": "Indicates whether rollback should be performed." }, "details": { "$ref": "#/definitions/MigrateExpressRouteCircuitHealthCheckDetails", "description": "Detailed health check information for migration." } } }, "MigrateExpressRouteCircuitRequest": { "type": "object", "description": "Request model for express route circuit migration operations.", "properties": { "targetPeeringLocation": { "type": "string", "description": "The target peering location for circuit migration." }, "targetPortMapping": { "type": "array", "description": "The source-to-target port mappings for circuit migration.", "items": { "$ref": "#/definitions/PortMapping" }, "x-ms-identifiers": [ "sourcePortId" ] }, "portId": { "type": "string", "description": "The port identifier used for shutDownBgp, migrate, restoreBgp, and rollback operations." } } }, "MigrateExpressRouteCircuitValidateAndHealthCheckRequest": { "type": "object", "description": "Request model used by validate and health check circuit migration operations.", "properties": { "targetPeeringLocation": { "type": "string", "description": "The target peering location for circuit migration." }, "targetPortMapping": { "type": "array", "description": "The source-to-target port mappings for circuit migration.", "items": { "$ref": "#/definitions/PortMapping" }, "x-ms-identifiers": [ "sourcePortId" ] } }, "required": [ "targetPeeringLocation", "targetPortMapping" ] }, "MigrateExpressRouteCircuitValidateResponse": { "type": "object", "description": "Response for express route circuit migration validation operation.", "properties": { "status": { "type": "string", "description": "The validation status." } } }, "PatchRouteFilter": { "type": "object", "description": "Route Filter Resource.", "properties": { "properties": { "$ref": "#/definitions/RouteFilterPropertiesFormat", "description": "Properties of the route filter.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "readOnly": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Resource type.", "readOnly": true }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "PatchRouteFilterRule": { "type": "object", "description": "Route Filter Rule Resource.", "properties": { "properties": { "$ref": "#/definitions/RouteFilterRulePropertiesFormat", "description": "Properties of the route filter rule.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "readOnly": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "PeerExpressRouteCircuitConnection": { "type": "object", "description": "Peer Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.", "properties": { "properties": { "$ref": "#/definitions/PeerExpressRouteCircuitConnectionPropertiesFormat", "description": "Properties of the peer express route circuit connection.", "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" } ] }, "PeerExpressRouteCircuitConnectionListResult": { "type": "object", "description": "The response of a PeerExpressRouteCircuitConnection list operation.", "properties": { "value": { "type": "array", "description": "The PeerExpressRouteCircuitConnection items on this page", "items": { "$ref": "#/definitions/PeerExpressRouteCircuitConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PeerExpressRouteCircuitConnectionPropertiesFormat": { "type": "object", "description": "Properties of the peer express route circuit connection.", "properties": { "expressRouteCircuitPeering": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to Express Route Circuit Private Peering Resource of the circuit." }, "peerExpressRouteCircuitPeering": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to Express Route Circuit Private Peering Resource of the peered circuit." }, "addressPrefix": { "type": "string", "description": "/29 IP address space to carve out Customer addresses for tunnels." }, "circuitConnectionStatus": { "$ref": "./common.json#/definitions/CircuitConnectionStatus", "description": "Express Route Circuit connection state.", "readOnly": true }, "connectionName": { "type": "string", "description": "The name of the express route circuit connection resource." }, "authResourceGuid": { "type": "string", "description": "The resource guid of the authorization used for the express route circuit connection." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the peer express route circuit connection resource.", "readOnly": true } } }, "PeeringHealth": { "type": "object", "description": "Health information for a peering connection.", "properties": { "type": { "type": "string", "description": "The type of peering (for example, Private, Microsoft, Public)." }, "statsCurrent": { "$ref": "#/definitions/PeeringStats", "description": "The current peering statistics." }, "statsAtPrepare": { "$ref": "#/definitions/PeeringStats", "description": "The peering statistics captured at prepare phase." } } }, "PeeringStats": { "type": "object", "description": "Statistical information for a peering connection.", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp when these statistics were captured." }, "metrics": { "type": "array", "description": "The collection of peering metrics.", "items": { "$ref": "#/definitions/Metric" }, "x-ms-identifiers": [ "name" ] } } }, "PortMapping": { "type": "object", "description": "A mapping between source and target ports for migration.", "properties": { "sourcePortId": { "type": "string", "description": "The source port identifier." }, "targetPortId": { "type": "string", "description": "The target port identifier." } }, "required": [ "sourcePortId", "targetPortId" ] }, "PortMigrationInfo": { "type": "object", "description": "Information about a port migration status.", "properties": { "portId": { "type": "string", "description": "The identifier of the port being migrated." }, "status": { "type": "string", "description": "The migration status for the port." }, "phase": { "type": "string", "description": "The current migration phase for the port." }, "failureReason": { "type": "string", "description": "The reason for failure if migration failed for the port." }, "peerings": { "type": "array", "description": "The peering health details for the port.", "items": { "$ref": "#/definitions/PeeringHealth" }, "x-ms-identifiers": [ "type" ] }, "sourcePortId": { "type": "string", "description": "The source port identifier before migration." }, "sourcePortStats": { "$ref": "#/definitions/SourcePortStats", "description": "The source port statistics before migration." } } }, "RouteFilter": { "type": "object", "description": "Route Filter Resource.", "properties": { "properties": { "$ref": "#/definitions/RouteFilterPropertiesFormat", "description": "Properties of the route filter.", "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/TrackedResourceWithSettableIdOptionalLocation" } ] }, "RouteFilterListResult": { "type": "object", "description": "The response of a RouteFilter list operation.", "properties": { "value": { "type": "array", "description": "The RouteFilter items on this page", "items": { "$ref": "#/definitions/RouteFilter" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RouteFilterPropertiesFormat": { "type": "object", "description": "Route Filter Resource.", "properties": { "rules": { "type": "array", "description": "Collection of RouteFilterRules contained within a route filter.", "items": { "$ref": "#/definitions/RouteFilterRule" } }, "peerings": { "type": "array", "description": "A collection of references to express route circuit peerings.", "items": { "$ref": "#/definitions/ExpressRouteCircuitPeering" }, "readOnly": true }, "ipv6Peerings": { "type": "array", "description": "A collection of references to express route circuit ipv6 peerings.", "items": { "$ref": "#/definitions/ExpressRouteCircuitPeering" }, "readOnly": true }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the route filter resource.", "readOnly": true } } }, "RouteFilterRule": { "type": "object", "description": "Route Filter Rule Resource.", "properties": { "properties": { "$ref": "#/definitions/RouteFilterRulePropertiesFormat", "description": "Properties of the route filter rule.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "location": { "type": "string", "description": "Resource location." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "RouteFilterRuleListResult": { "type": "object", "description": "Response for the ListRouteFilterRules API service call.", "properties": { "value": { "type": "array", "description": "The RouteFilterRule items on this page", "items": { "$ref": "#/definitions/RouteFilterRule" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RouteFilterRulePropertiesFormat": { "type": "object", "description": "Route Filter Rule Resource.", "properties": { "access": { "$ref": "./common.json#/definitions/Access", "description": "The access type of the rule." }, "routeFilterRuleType": { "$ref": "./common.json#/definitions/RouteFilterRuleType", "description": "The rule type of the rule." }, "communities": { "type": "array", "description": "The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].", "items": { "type": "string" } }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the route filter rule resource.", "readOnly": true } }, "required": [ "access", "routeFilterRuleType", "communities" ] }, "ServiceEndpointPolicy": { "type": "object", "description": "Service End point policy resource.", "properties": { "properties": { "$ref": "#/definitions/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" } ] }, "ServiceEndpointPolicyDefinition": { "type": "object", "description": "Service Endpoint policy definitions.", "properties": { "properties": { "$ref": "#/definitions/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" } ] }, "ServiceEndpointPolicyDefinitionListResult": { "type": "object", "description": "The response of a ServiceEndpointPolicyDefinition list operation.", "properties": { "value": { "type": "array", "description": "The ServiceEndpointPolicyDefinition items on this page", "items": { "$ref": "#/definitions/ServiceEndpointPolicyDefinition" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "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 } } }, "ServiceEndpointPolicyListResult": { "type": "object", "description": "The response of a ServiceEndpointPolicy list operation.", "properties": { "value": { "type": "array", "description": "The ServiceEndpointPolicy items on this page", "items": { "$ref": "#/definitions/ServiceEndpointPolicy" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "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": "#/definitions/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" } } } }, "SourcePortStats": { "type": "object", "description": "Statistics from the source port before migration.", "properties": { "peerings": { "type": "array", "description": "The peering health information from the source port.", "items": { "$ref": "#/definitions/PeeringHealth" }, "x-ms-identifiers": [ "type" ] } } } }, "parameters": {} }