You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/operator-nexus/concepts-nexus-ipprefix.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,8 +21,8 @@ IP prefix resources allow operators to create a list of network prefixes with se
21
21
22
22
## Functionality
23
23
24
-
The primary purpose of IP Prefix Resources is to define match criteria and action for route policies based on the network prefixes of routes. Route policies are rules that determine how routes are imported and exported between different networks, such as the infrastructure network, the workload network, and the external network. By using IP Prefix Resources, operators can control which routes are allowed or denied.
24
+
The primary purpose of IP prefix resources is to define match criteria and actions for route policies based on the network prefixes of routes. Route policies are rules that determine how routes are imported and exported between different networks, such as the infrastructure network, the workload network, and the external network. By using IP prefix resources, operators can control which routes are allowed or denied.
25
25
26
-
The conditions of a Route Policy are specified using the IP Prefix resource. This resource, modeled as an ARM resource under Microsoft.managednetworkfabric, defines the match conditions and actions for the route policy based on the IP prefix of the routes.
26
+
The conditions of a Route Policy are specified using the IP prefix resource. This resource, modeled as an ARM resource under Microsoft.managednetworkfabric, defines the match conditions and actions for the route policy based on the IP prefix of the routes.
27
27
28
-
The operator can create different combinations of IP Prefix rules to achieve different routing behaviors. For example, the operator can use the EqualTo condition to match exact prefixes, or use the NotEqualTo condition to match prefixes that aren't equal to the specified prefix. The operator can also use the `Permit` action to allow the matching prefixes, or use the `Deny` action to block the matching prefixes. The sequence number determines the order of evaluation of the rules, from lowest to highest. The operator can use the sequence number to create more specific rules before more general rules, or to create exceptions to the default rules.
28
+
The operator can create different combinations of IP prefix rules to achieve different routing behaviors. For example, the operator can use the `EqualTo` condition to match exact prefixes, or use the `NotEqualTo` condition to match prefixes that aren't equal to the specified prefix. The operator can also use the `Permit` action to allow the matching prefixes, or use the `Deny` action to block the matching prefixes. The sequence number determines the order of evaluation of the rules, from lowest to highest. The operator can use the sequence number to create more specific rules before more general rules, or to create exceptions to the default rules.
The properties and rules of the IP Prefix resource are:
35
+
The properties and rules of the IP prefix resource are:
63
36
64
-
- `resource-group`: The name of the resource group where you want to create the IP Prefix resource.
37
+
- `resource-group`: The name of the resource group where you want to create the IP prefix resource.
65
38
66
-
- `name`: The name of the IP Prefix resource.
39
+
- `name`: The name of the IP prefix resource.
67
40
68
-
- `location`: The Azure region where you want to create the IP Prefix resource.
41
+
- `location`: The Azure region where you want to create the IP prefix resource.
69
42
70
-
- `ip-prefix-rules`: The list of rules that define the match criteria and action for the IP Prefix resource. Each rule has the following properties:
43
+
- `ip-prefix-rules`: The list of rules that define the match criteria and action for the IP prefix resource. Each rule has the following properties:
71
44
72
45
73
-
- `action`: The action to take when the condition is met. It can be either Permit or Deny. Permit means to allow the route, and Deny means to reject the route.
46
+
- `action`: The action to take when the condition is met. It can be either `Permit` or `Deny`. `Permit` means to allow the route, and `Deny` means to reject the route.
74
47
75
48
- `condition`: The condition to compare the network prefix of the route with the network prefix of the rule. It can be one of the following values:
76
49
@@ -80,37 +53,37 @@ To create an IP Prefix resource, follow these steps:
80
53
81
54
- `GreaterThanOrEqualTo`: The condition is true when the network prefix of the route is greater than or equal to the network prefix of the rule.
82
55
83
-
- `networkPrefix`: The network segment to match. It's an IP address and a prefix length, such as 10.10.10.0/28 or 2001:db8::/64.
56
+
- `networkPrefix`: The network segment to match. It's an IP address and a prefix length, such as 10.10.10.0/28 or 2001:db8::/64. For IPv4, the prefix length must be 1-32. For IPv6, the prefix length must be 1-128.
84
57
85
58
- `sequenceNumber`: The order of evaluation of the rule, from lowest to highest. The rule with the lowest sequence number is evaluated first, and the rule with the highest sequence number is evaluated last. If a rule matches the route, the evaluation stops and the action of the rule is executed. If no rule matches the route, the default action is Deny.
86
59
87
60
88
-
2. Create the IP Prefix resource using the azcli command. You can use the same command as in the previous step, or modify it as per your requirements.
61
+
2. Create the IP prefix resource using the azcli command. You can use the same command as in the previous step, or modify it as per your requirements.
89
62
90
-
3. Verify that the IP Prefix resource is created successfully. You can use the `az networkfabric ipprefix show` command to show the details of the IP Prefix resource. You can use the following example as a reference:
63
+
3. Verify that the IP prefix resource is created successfully. You can use the `az networkfabric ipprefix show` command to show the details of the IP prefix resource. You can use the following example as a reference:
91
64
92
65
```azurecli
93
-
networkfabric ipprefix show \
66
+
az networkfabric ipprefix show \
94
67
--resource-group myResourceGroup \
95
68
--name myIpPrefix
96
69
```
97
70
98
-
In this example, `myResourceGroup` is the name of the resource group where you created the IP Prefix resource, and `myIpPrefix` is the name of the IP Prefix resource.
71
+
In this example, `myResourceGroup` is the name of the resource group where you created the IP prefix resource, and `myIpPrefix` is the name of the IP prefix resource.
99
72
100
-
The response should contain the properties and rules of the IP Prefix resource, such as the ID, type, ipPrefixRules, location, name, provisioningState, resourceGroup, and tags.
73
+
The response should contain the properties and rules of the IP prefix resource, such as the ID, type, ipPrefixRules, location, name, provisioningState, resourceGroup, and tags.
101
74
102
-
### Show an IP Prefix resource
75
+
### Show an IP prefix resource
103
76
104
-
To get the details of an existing IP Prefix resource by its ID or name, use the following command:
77
+
To get the details of an existing IP prefix resource by its ID or name, use the following command:
105
78
106
79
```azurecli
107
-
# Get the details of an IP Prefix resource by its name
80
+
# Get the details of an IP prefix resource by its name
108
81
az networkfabric ipprefix show \
109
82
--resource-group myResourceGroup \
110
83
--name myIpPrefix
111
84
```
112
85
113
-
The REST API response body for getting the details of an IP Prefix resource by its ID is as follows:
86
+
The REST API response body is as follows:
114
87
115
88
```json
116
89
{
@@ -136,13 +109,13 @@ The REST API response body for getting the details of an IP Prefix resource by i
136
109
}
137
110
```
138
111
139
-
### Updating an IP Prefix Resource
112
+
### Updating an IP prefix resource
140
113
141
-
To update an IP Prefix resource, follow these steps:
114
+
To update an IP prefix resource, follow these steps:
142
115
143
-
1. Specify the properties and rules of the IP Prefix resource that you want to update. You can use the same JSON template as in the previous section, or modify it as per your requirements.
116
+
1. Specify the properties and rules of the IP prefix resource that you want to update. You can use the same JSON template as in the previous section, or modify it as per your requirements.
144
117
145
-
2. Update the IP Prefix resource using the Azure CLI command or the REST API method. You can use the following examples as a reference:
118
+
2. Update the IP prefix resource using the Azure CLI command or the REST API method. You can use the following examples as a reference:
146
119
147
120
```azurecli
148
121
az networkfabric ipprefix update \
@@ -151,20 +124,20 @@ To update an IP Prefix resource, follow these steps:
In this example, `resourceGroupName` is the name of the resource group where you created the IP Prefix resource, `ipPrefixName` is the name of the IP Prefix resource, and the `--add` option adds a new rule to the ipPrefixRules property. The new rule denies routes with network prefix 30.30.30.0/24 and has a sequence number of 30.
127
+
In this example, `resourceGroupName` is the name of the resource group where you created the IP prefix resource, `ipPrefixName` is the name of the IP prefix resource, and the `--add` option adds a new rule to the ipPrefixRules property. The new rule denies routes with network prefix 30.30.30.0/24 and has a sequence number of 30.
155
128
156
-
### Deleting an IP Prefix resource
129
+
### Deleting an IP prefix resource
157
130
158
-
To delete an existing IP Prefix resource by its ID or name, use the following command:
131
+
To delete an existing IP prefix resource by its ID or name, use the following command:
159
132
160
133
```azurecli
161
-
# Delete an IP Prefix resource by its name
134
+
# Delete an IP prefix resource by its name
162
135
az networkfabric ipprefix delete \
163
136
--resource-group myResourceGroup \
164
137
--name myIpPrefix
165
138
```
166
139
167
-
The REST API request body for deleting an IP Prefix resource by its ID is as follows:
140
+
The REST API request body for deleting an IP prefix resource by its ID is as follows:
0 commit comments