Skip to content

Commit be3cf08

Browse files
Proofreading fixes
1 parent 4180a9b commit be3cf08

File tree

2 files changed

+31
-58
lines changed

2 files changed

+31
-58
lines changed

articles/operator-nexus/concepts-nexus-ipprefix.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ IP prefix resources allow operators to create a list of network prefixes with se
2121

2222
## Functionality
2323

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.
2525

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.
2727

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.

articles/operator-nexus/how-to-ip-prefixes.md

Lines changed: 28 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -9,47 +9,20 @@ ms.date: 02/28/2024
99
ms.custom: template-how-to
1010
---
1111

12-
# Overview
12+
# How to Create and Manage IP Prefixes
1313

1414
This article explains the main management operations for IP prefixes and IP prefix rules in Azure Operator Nexus.
1515

16-
## Properties 
17-
18-
The IpPrefix resource has the following properties: 
19-
20-
1. **location**: The Azure region where the resource is located. 
21-
22-
2. **properties**: The properties of the IpPrefix resource, which include: 
23-
24-
- **configurationState**: The configuration state of the resource. 
25-
26-
- **provisioningState**: The provisioning state of the resource. 
27-
28-
- **administrativeState**: The administrative state of the resource. 
29-
30-
- **ipPrefixRules**: A list of IP Prefix Rules. Each rule has the following properties: 
31-
32-
- **action**: The action to be taken on the configuration (`Permit` or `Deny`). 
33-
34-
- **sequenceNumber**: The sequence to insert to/delete from the existing route. The sequence number must be between 1 and 4294967295. 
35-
36-
- **networkPrefix**: The network prefix specifying IPv4/IPv6 packets to be permitted or denied.
37-
38-
- **condition**: Specifies the prefix-list bounds. Possible values are `EqualTo`, `GreaterThanOrEqualTo`, `LesserThanOrEqualTo`, and `Range`.
39-
40-
- **subnetMaskLength**: Gives the minimum NetworkPrefix length to be matched. Possible values for IPv4 are 1-32. Possible values for IPv6 are 1-128. 
41-
42-
4316
## IP prefix operations
4417

4518

4619
### Create an IP prefix
4720

4821

49-
To create an IP Prefix resource, follow these steps: 
22+
To create an IP prefix resource, follow these steps: 
5023

5124

52-
1. Specify the properties and rules of the IP Prefix resource. You can use the following azcli command as a reference: 
25+
1. Specify the properties and rules of the IP prefix resource. You can use the following azcli command as a reference: 
5326

5427
```azurecli
5528
az networkfabric ipprefix create--resource-group myResourceGroup \
@@ -59,18 +32,18 @@ To create an IP Prefix resource, follow these steps: 
5932
--ip-prefix-rules action=Permit condition=EqualTo networkPrefix=20.20.20.0/24 sequenceNumber=20
6033
```
6134
62-
The properties and rules of the IP Prefix resource are: 
35+
The properties and rules of the IP prefix resource are: 
6336
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. 
6538
66-
- `name`: The name of the IP Prefix resource. 
39+
- `name`: The name of the IP prefix resource. 
6740
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. 
6942
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: 
7144
7245
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. 
7447
7548
- `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: 
7649
@@ -80,37 +53,37 @@ To create an IP Prefix resource, follow these steps: 
8053
8154
- `GreaterThanOrEqualTo`: The condition is true when the network prefix of the route is greater than or equal to the network prefix of the rule.
8255
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.
8457
8558
- `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. 
8659
8760
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.
8962
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: 
9164
9265
```azurecli
93-
networkfabric ipprefix show \
66+
az networkfabric ipprefix show \
9467
--resource-group myResourceGroup \
9568
--name myIpPrefix 
9669
```
9770
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. 
9972
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. 
10174
102-
### Show an IP Prefix resource
75+
### Show an IP prefix resource
10376
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: 
10578
10679
```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
10881
az networkfabric ipprefix show \
10982
--resource-group myResourceGroup \
11083
--name myIpPrefix
11184
```
11285

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: 
11487

11588
```json
11689
{
@@ -136,13 +109,13 @@ The REST API response body for getting the details of an IP Prefix resource by i
136109
}
137110
```
138111

139-
### Updating an IP Prefix Resource 
112+
### Updating an IP prefix resource 
140113

141-
To update an IP Prefix resource, follow these steps: 
114+
To update an IP prefix resource, follow these steps: 
142115

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. 
144117

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: 
146119

147120
```azurecli
148121
az networkfabric ipprefix update \
@@ -151,20 +124,20 @@ To update an IP Prefix resource, follow these steps: 
151124
--ip-prefix-rules "[{action:Permit,sequenceNumber:4155123341,networkPrefix:'10.10.10.10/30',condition:GreaterThanOrEqualTo,subnetMaskLength:10}]"
152125
```
153126
154-
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. 
155128
156-
### Deleting an IP Prefix resource 
129+
### Deleting an IP prefix resource 
157130
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: 
159132
160133
```azurecli
161-
# Delete an IP Prefix resource by its name
134+
# Delete an IP prefix resource by its name
162135
az networkfabric ipprefix delete \
163136
--resource-group myResourceGroup \
164137
--name myIpPrefix
165138
```
166139

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: 
168141

169142
```json
170143
{

0 commit comments

Comments
 (0)