Skip to content

Commit ca37f6e

Browse files
committed
edit pass: four-operator-nexus-route-articles
1 parent d8bf188 commit ca37f6e

File tree

1 file changed

+48
-51
lines changed

1 file changed

+48
-51
lines changed

articles/operator-nexus/reference-nexus-route-policy-config-examples.md

Lines changed: 48 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ This article gives examples of how to configure route policies for Azure Operato
1616

1717
The JSON format is a common way to define a route policy resource in Azure Operator Nexus. The JSON follows the schema of the route policy resource, which has the following properties:
1818

19-
- **id**: The ID of the route policy resource in the format `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}`.
20-
- **type**: The type of the resource, which is `microsoft.managednetworkfabric/routepolicies`.
21-
- **addressFamilyType**: The address family type of the route policy resource, which specifies the IP version of the route policy. It can be either IPv4 or IPv6.
22-
- **statements**: An array of statements that define the routing behavior of the route policy resource. Each statement has a sequence number, a condition, and an action property.
23-
- **defaultAction**: The default action of the route policy resource, which specifies the outcome for routes that don't match any statement in the route policy. It can be either Permit or Deny.
24-
- **configurationState**: The configuration state of the route policy resource, which indicates whether the route policy was successfully applied or not. It can be either Succeeded, Failed, or Updating.
19+
- **id**: The ID of the route policy resource in the format `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}`.
20+
- **type**: The type of the resource, which is `microsoft.managednetworkfabric/routepolicies`.
21+
- **addressFamilyType**: The address family type of the route policy resource, which specifies the IP version of the route policy. It can be either IPv4 or IPv6.
22+
- **statements**: An array of statements that define the routing behavior of the route policy resource. Each statement has a sequence number, a condition, and an action property.
23+
- **defaultAction**: The default action of the route policy resource, which specifies the outcome for routes that don't match any statement in the route policy. It can be either Permit or Deny.
24+
- **configurationState**: The configuration state of the route policy resource, which indicates whether the route policy was successfully applied or not. It can be either Succeeded, Failed, or Updating.
2525

2626
Here's an example of a route policy resource specified in JSON format:
2727

@@ -75,11 +75,8 @@ To use the Azure CLI commands or the REST API methods, you need to have an Azure
7575
Here are some examples of the Azure CLI commands or the REST API methods to create and manage route policy resources:
7676

7777
- To create a route policy resource, you can use the `az networkfabric routepolicy create` command or the PUT method with the `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}` URI.
78-
7978
- To show the details of a route policy resource, you can use the `az networkfabric routepolicy show` command or the GET method with the `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}` URI.
80-
8179
- To update a route policy resource, you can use the `az networkfabric routepolicy update` command or the PATCH method with the `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}` URI.
82-
8380
- To delete a route policy resource, you can use the `az networkfabric routepolicy delete` command or the DELETE method with the `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}` URI.
8481

8582
## Use the Permit, Deny, and Continue actions in the route policy
@@ -88,59 +85,59 @@ The Permit, Deny, and Continue actions are used in the route policy to control
8885

8986
- The Permit action allows the matching routes and applies the IP community properties to the routes. The IP community properties specify how to add, remove, or overwrite community values and extended community values of the routes.
9087

91-
For example, the operator can use the following statement to permit any route that has an IP prefix equal to the IP prefix resource with the ID `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/{ipPrefixName}` and add the IP community value from the IP community resource with the ID `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}`.
88+
For example, the operator can use the following statement to permit any route that has an IP prefix equal to the IP prefix resource with the ID `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/{ipPrefixName}` and add the IP community value from the IP community resource with the ID `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}`.
9289

93-
```json
94-
{
95-
"sequenceNumber": 10,
96-
"condition": {
97-
"ipPrefixId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/{ipPrefixName}"
98-
},
99-
"action": {
100-
"actionType": "Permit",
101-
"ipCommunityProperties": {
102-
"set": {
103-
"ipCommunityIds": [
104-
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}"
105-
]
90+
```json
91+
{
92+
"sequenceNumber": 10,
93+
"condition": {
94+
"ipPrefixId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/{ipPrefixName}"
95+
},
96+
"action": {
97+
"actionType": "Permit",
98+
"ipCommunityProperties": {
99+
"set": {
100+
"ipCommunityIds": [
101+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}"
102+
]
103+
}
104+
}
106105
}
107106
}
108-
}
109-
}
110-
```
107+
```
111108

112109
- The Deny action rejects the matching routes and stops the evaluation of the route policy.
113110

114-
For example, the operator can use the following statement to deny any route that has an IP community value equal to the IP community resource with the ID `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}`.
115-
116-
```json
117-
{
118-
"sequenceNumber": 20,
119-
"condition": {
120-
"ipCommunityId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}"
121-
},
122-
"action": {
123-
"actionType": "Deny"
124-
}
125-
}
126-
```
111+
For example, the operator can use the following statement to deny any route that has an IP community value equal to the IP community resource with the ID `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}`.
112+
113+
```json
114+
{
115+
"sequenceNumber": 20,
116+
"condition": {
117+
"ipCommunityId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}"
118+
},
119+
"action": {
120+
"actionType": "Deny"
121+
}
122+
}
123+
```
127124

128125
- The Continue action continues the evaluation of the route policy with the next statement and applies the IP community properties to the routes. The IP community properties specify how to add, remove, or overwrite community values and extended community values of the routes.
129126

130-
For example, the operator can use the following statement to continue the evaluation of the route policy with the next statement:
127+
For example, the operator can use the following statement to continue the evaluation of the route policy with the next statement:
131128

132-
```json
133-
{
134-
"sequenceNumber": 30,
135-
"condition": {
136-
"ipExtendedCommunityId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/{ipExtendedCommunityName}"
137-
},
138-
"action": {
139-
"actionType": "Continue"
129+
```json
130+
{
131+
"sequenceNumber": 30,
132+
"condition": {
133+
"ipExtendedCommunityId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/{ipExtendedCommunityName}"
134+
},
135+
"action": {
136+
"actionType": "Continue"
137+
}
138+
}
140139
}
141-
}
142-
}
143-
```
140+
```
144141

145142
## Use the IP community properties to add, remove, or overwrite community values and extended community values of the routes
146143

0 commit comments

Comments
 (0)