Microsoft Azure Routing Configuration allows users to define and manage routes for directing network traffic within their Azure virtual network. By setting up routing tables, users can control how traffic is routed between subnets, virtual networks, and external networks. This configuration enables users to ensure that network traffic is efficiently and securely directed to its intended destination.
swagger: '2.0'
info:
title: Microsoft Azure RoutingConfiguration
version: 2023-03-01-preview
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
- user_impersonation
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Azure Active Directory OAuth2 Flow.
scopes:
user_impersonation: impersonate your user account
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations
: get:
tags:
- RoutingConfigurations
operationId: microsoftAzureRoutingconfigurationsList
description: >-
Lists all the network manager routing configurations in a network
manager, in a paginated format.
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
- $ref: '#/parameters/NetworkManagerNameParameter'
- $ref: '#/parameters/ListTopParameter'
- $ref: '#/parameters/ListSkipTokenParameter'
responses:
'200':
description: >-
Get successful. The operation returns all routing configuration
resources in the specified network manager, in a paginated format
schema:
$ref: '#/definitions/RoutingConfigurationListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List routing configurations in a network manager:
$ref: ./examples/NetworkManagerRoutingConfigurationList.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}
: 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
- $ref: '#/parameters/NetworkManagerNameParameter'
- $ref: '#/parameters/RoutingConfigurationParameter'
get:
tags:
- RoutingConfigurations
description: Retrieves a network manager routing configuration.
operationId: microsoftAzureRoutingconfigurationsGet
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/RoutingConfiguration'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
Get routing configurations:
$ref: ./examples/NetworkManagerRoutingConfigurationGet.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname
put:
tags:
- RoutingConfigurations
description: Creates or updates a network manager routing configuration.
operationId: microsoftAzureRoutingconfigurationsCreateorupdate
parameters:
- name: routingConfiguration
in: body
required: true
schema:
$ref: '#/definitions/RoutingConfiguration'
description: The routing configuration to create or update
responses:
'200':
description: Updated Routing Configuration
schema:
$ref: '#/definitions/RoutingConfiguration'
'201':
description: Created Routing Configuration
schema:
$ref: '#/definitions/RoutingConfiguration'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
Create network manager routing configuration:
$ref: ./examples/NetworkManagerRoutingConfigurationPut.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname
delete:
tags:
- RoutingConfigurations
description: Deletes a network manager routing configuration.
operationId: microsoftAzureRoutingconfigurationsDelete
responses:
'202':
description: Accepted and will complete asynchronously.
headers:
Location:
description: >-
The URL of the resource used to check the status of the
asynchronous operation.
type: string
'204':
description: Request successful. Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Delete network manager routing configuration:
$ref: ./examples/NetworkManagerRoutingConfigurationDelete.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections
: get:
tags:
- RoutingRuleCollections
operationId: microsoftAzureRoutingrulecollectionsList
description: >-
Lists all the rule collections in a routing configuration, in a
paginated format.
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
- $ref: '#/parameters/NetworkManagerNameParameter'
- $ref: '#/parameters/RoutingConfigurationParameter'
- $ref: '#/parameters/ListTopParameter'
- $ref: '#/parameters/ListSkipTokenParameter'
responses:
'200':
description: >-
Get successful. The operation returns all ruleCollections in the
specified routing configuration, in a paginated format
schema:
$ref: '#/definitions/RoutingRuleCollectionListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List routing rule collections:
$ref: ./examples/NetworkManagerRoutingRuleCollectionList.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}
: 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
- $ref: '#/parameters/NetworkManagerNameParameter'
- $ref: '#/parameters/RoutingConfigurationParameter'
- $ref: '#/parameters/RuleCollectionParameter'
get:
tags:
- RoutingRuleCollections
description: Gets a network manager routing configuration rule collection.
operationId: microsoftAzureRoutingrulecollectionsGet
responses:
'200':
description: Successful operation
schema:
$ref: '#/definitions/RoutingRuleCollection'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
Gets routing rule collection:
$ref: ./examples/NetworkManagerRoutingRuleCollectionGet.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname
put:
tags:
- RoutingRuleCollections
description: Creates or updates a routing rule collection.
operationId: microsoftAzureRoutingrulecollectionsCreateorupdate
parameters:
- name: ruleCollection
in: body
required: true
schema:
$ref: '#/definitions/RoutingRuleCollection'
description: The Rule Collection to create or update
responses:
'200':
description: Updated Rule Collection
schema:
$ref: '#/definitions/RoutingRuleCollection'
'201':
description: Created Rule Collection
schema:
$ref: '#/definitions/RoutingRuleCollection'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
Create or Update a routing rule collection:
$ref: ./examples/NetworkManagerRoutingRuleCollectionPut.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname
delete:
tags:
- RoutingRuleCollections
description: Deletes an routing rule collection.
operationId: microsoftAzureRoutingrulecollectionsDelete
responses:
'202':
description: Accepted and will complete asynchronously.
headers:
Location:
description: >-
The URL of the resource used to check the status of the
asynchronous operation.
type: string
'204':
description: Request successful. Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Deletes an routing rule collection:
$ref: ./examples/NetworkManagerRoutingRuleCollectionDelete.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules
: 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
- $ref: '#/parameters/NetworkManagerNameParameter'
- $ref: '#/parameters/RoutingConfigurationParameter'
- $ref: '#/parameters/RuleCollectionParameter'
- $ref: '#/parameters/ListTopParameter'
- $ref: '#/parameters/ListSkipTokenParameter'
get:
tags:
- RoutingRules
description: List all network manager routing configuration routing rules.
operationId: microsoftAzureRoutingrulesList
responses:
'200':
description: Successful operation
schema:
$ref: '#/definitions/RoutingRuleListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
List routing rules:
$ref: ./examples/NetworkManagerRoutingRuleList.json
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname Rules
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}
: 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
- $ref: '#/parameters/NetworkManagerNameParameter'
- $ref: '#/parameters/RoutingConfigurationParameter'
- $ref: '#/parameters/RuleCollectionParameter'
- $ref: '#/parameters/RoutingConfigurationsRuleParameter'
get:
tags:
- RoutingRules
description: Gets a network manager routing configuration routing rule.
operationId: microsoftAzureRoutingrulesGet
responses:
'200':
description: Successful operation
schema:
$ref: '#/definitions/RoutingRule'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
Gets routing rule:
$ref: ./examples/NetworkManagerRoutingRuleGet.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname Rules Rulename
put:
tags:
- RoutingRules
description: Creates or updates an routing rule.
operationId: microsoftAzureRoutingrulesCreateorupdate
parameters:
- name: routingRule
in: body
required: true
schema:
$ref: '#/definitions/RoutingRule'
description: The routing rule to create or update
responses:
'200':
description: Updated rule
schema:
$ref: '#/definitions/RoutingRule'
'201':
description: Created rule
schema:
$ref: '#/definitions/RoutingRule'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
Create an routing rule:
$ref: ./examples/NetworkManagerRoutingRulePut.json
Create a default routing rule:
$ref: ./examples/NetworkManagerRoutingRulePut.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname Rules Rulename
delete:
tags:
- RoutingRules
description: Deletes a routing rule.
operationId: microsoftAzureRoutingrulesDelete
responses:
'202':
description: Accepted and will complete asynchronously.
headers:
Location:
description: >-
The URL of the resource used to check the status of the
asynchronous operation.
type: string
'204':
description: Request successful. Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Deletes a routing rule:
$ref: ./examples/NetworkManagerRoutingRuleDelete.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname Rules Rulename
definitions:
RoutingConfiguration:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/RoutingConfigurationPropertiesFormat'
description: >-
Indicates the properties for the network manager routing
configuration.
systemData:
readOnly: true
description: The system metadata related to this resource.
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/systemData
allOf:
- $ref: ./network.json#/definitions/ProxyResource
description: Defines the routing configuration
RoutingConfigurationPropertiesFormat:
type: object
properties:
description:
type: string
description: A description of the routing configuration.
provisioningState:
readOnly: true
$ref: ./network.json#/definitions/ProvisioningState
description: The provisioning state of the resource.
resourceGuid:
type: string
readOnly: true
description: Unique identifier for this resource.
description: Defines the routing configuration properties.
RoutingConfigurationListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/RoutingConfiguration'
description: Gets a page of routing configurations
nextLink:
type: string
description: Gets the URL to get the next page of results.
description: A list of network manager routing configurations
RoutingRuleCollection:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/RoutingRuleCollectionPropertiesFormat'
description: >-
Indicates the properties for the network manager routing rule
collection.
systemData:
readOnly: true
description: The system metadata related to this resource.
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/systemData
allOf:
- $ref: ./network.json#/definitions/ProxyResource
description: Defines the routing rule collection.
RoutingRuleCollectionPropertiesFormat:
type: object
properties:
description:
type: string
description: A description of the routing rule collection.
provisioningState:
readOnly: true
$ref: ./network.json#/definitions/ProvisioningState
description: The provisioning state of the resource.
resourceGuid:
type: string
readOnly: true
description: Unique identifier for this resource.
appliesTo:
type: array
x-ms-identifiers:
- networkGroupId
items:
$ref: '#/definitions/NetworkManagerRoutingGroupItem'
description: Groups for configuration
disableBgpRoutePropagation:
type: boolean
default: true
description: Determines whether BGP route propagation is enabled. Defaults to true.
localRouteSetting:
$ref: '#/definitions/RoutingRuleCollectionLocalRouteSetting'
description: Indicates local route setting for this particular rule collection.
required:
- appliesTo
- localRouteSetting
description: Defines the routing rule collection properties.
RoutingRuleCollectionLocalRouteSetting:
type: string
description: Routing rule collection local route setting.
enum:
- NotSpecified
- DirectRoutingWithinVNet
- DirectRoutingWithinSubnet
x-ms-enum:
name: RoutingRuleCollectionLocalRouteSetting
modelAsString: true
NetworkManagerRoutingGroupItem:
type: object
properties:
networkGroupId:
type: string
description: Network manager group Id.
required:
- networkGroupId
description: Network manager routing group item.
RoutingRuleCollectionListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/RoutingRuleCollection'
description: A list of network manager routing configuration rule collections
nextLink:
type: string
description: Gets the URL to get the next set of results.
description: Routing configuration rule collection list result.
RoutingRule:
type: object
properties:
properties:
$ref: '#/definitions/RoutingRulePropertiesFormat'
x-ms-client-flatten: true
description: Indicates the properties of the routing rule
systemData:
readOnly: true
description: The system metadata related to this resource.
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/systemData
allOf:
- $ref: ./network.json#/definitions/ProxyResource
description: Network routing rule.
RoutingRulePropertiesFormat:
type: object
properties:
description:
type: string
description: A description for this rule.
provisioningState:
readOnly: true
$ref: ./network.json#/definitions/ProvisioningState
description: The provisioning state of the resource.
resourceGuid:
type: string
readOnly: true
description: Unique identifier for this resource.
destination:
$ref: '#/definitions/RoutingRuleRouteDestination'
description: Indicates the destination for this particular rule.
nextHop:
$ref: '#/definitions/RoutingRuleNextHop'
description: Indicates the next hop for this particular rule.
required:
- destination
- nextHop
description: Routing routing rule resource.
RoutingRuleRouteDestination:
type: object
properties:
type:
$ref: '#/definitions/RoutingRuleDestinationType'
description: Destination type.
destinationAddress:
type: string
description: Destination address.
required:
- type
- destinationAddress
description: Route destination.
RoutingRuleNextHop:
type: object
properties:
nextHopType:
$ref: '#/definitions/RoutingRuleNextHopType'
description: Next hop type.
nextHopAddress:
type: string
description: >-
Next hop address. Only relevant if the next hop type is
VirtualAppliance.
required:
- nextHopType
description: Next hop.
RoutingRuleNextHopType:
type: string
description: Routing rule next hop type.
enum:
- Internet
- NoNextNop
- VirtualAppliance
- VirtualNetworkGateway
- VnetLocal
x-ms-enum:
name: RoutingRuleNextHopType
modelAsString: true
RoutingRuleDestinationType:
type: string
description: Routing rule destination type.
enum:
- AddressPrefix
- ServiceTag
x-ms-enum:
name: RoutingRuleDestinationType
modelAsString: true
RoutingRuleListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/RoutingRule'
description: A list of routing rules.
nextLink:
type: string
description: The URL to get the next set of results.
description: Routing configuration rule list result.
parameters:
RoutingConfigurationParameter:
name: configurationName
in: path
description: The name of the network manager Routing Configuration.
pattern: ^[a-zA-Z0-9_.-]*$
required: true
type: string
x-ms-parameter-location: method
RuleCollectionParameter:
name: ruleCollectionName
in: path
description: The name of the network manager routing Configuration rule collection.
pattern: ^[a-zA-Z0-9_.-]*$
required: true
type: string
x-ms-parameter-location: method
RoutingConfigurationsRuleParameter:
name: ruleName
in: path
description: The name of the rule.
pattern: ^[a-zA-Z0-9_.-]*$
required: true
type: string
x-ms-parameter-location: method
NetworkManagerNameParameter:
name: networkManagerName
in: path
required: true
type: string
description: The name of the network manager.
pattern: ^[a-zA-Z0-9_.-]*$
x-ms-parameter-location: method
ListTopParameter:
name: $top
description: >-
An optional query parameter which specifies the maximum number of records
to be returned by the server.
in: query
required: false
type: integer
format: int32
minimum: 1
maximum: 20
x-ms-parameter-location: method
ListSkipTokenParameter:
name: $skipToken
description: >-
SkipToken is only used if a previous operation returned a partial result.
If a previous response contains a nextLink element, the value of the
nextLink element will include a skipToken parameter that specifies a
starting point to use for subsequent calls.
in: query
required: false
type: string
x-ms-parameter-location: method
tags:
- name: RoutingConfigurations
- name: RoutingRuleCollections
- name: RoutingRules