Route Filter Rules - Create Or Update
Creates or updates a route in the specified route filter.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}?api-version=2023-09-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. |
route
|
path | True |
string |
The name of the route filter. |
rule
|
path | True |
string |
The name of the route filter rule. |
subscription
|
path | True |
string |
The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Client API version. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
properties.access | True |
The access type of the rule. |
|
properties.communities | True |
string[] |
The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. |
properties.routeFilterRuleType | True |
The rule type of the rule. |
|
id |
string |
Resource ID. |
|
location |
string |
Resource location. |
|
name |
string |
The name of the resource that is unique within a resource group. This name can be used to access the resource. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Update successful. The operation returns the resulting Route Filter Rule resource. |
|
201 Created |
Create successful. The operation returns the resulting Route Filter Rule resource. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
RouteFilterRuleCreate
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName?api-version=2023-09-01
{
"properties": {
"access": "Allow",
"routeFilterRuleType": "Community",
"communities": [
"12076:5030",
"12076:5040"
]
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"name": "ruleName",
"properties": {
"provisioningState": "Succeeded",
"access": "Allow",
"routeFilterRuleType": "Community",
"communities": [
"12076:5030",
"12076:5040"
]
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"name": "ruleName",
"properties": {
"provisioningState": "Succeeded",
"access": "Allow",
"routeFilterRuleType": "Community",
"communities": [
"12076:5030",
"12076:5040"
]
}
}
Definitions
Name | Description |
---|---|
Access |
Access to be allowed or denied. |
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
Provisioning |
The current provisioning state. |
Route |
Route Filter Rule Resource. |
Route |
The rule type of the rule. |
Access
Access to be allowed or denied.
Name | Type | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
CloudError
An error response from the service.
Name | Type | Description |
---|---|---|
error |
Cloud error body. |
CloudErrorBody
An error response from the service.
Name | Type | Description |
---|---|---|
code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
details |
A list of additional details about the error. |
|
message |
string |
A message describing the error, intended to be suitable for display in a user interface. |
target |
string |
The target of the particular error. For example, the name of the property in error. |
ProvisioningState
The current provisioning state.
Name | Type | Description |
---|---|---|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
RouteFilterRule
Route Filter Rule Resource.
Name | Type | Description |
---|---|---|
etag |
string |
A unique read-only string that changes whenever the resource is updated. |
id |
string |
Resource ID. |
location |
string |
Resource location. |
name |
string |
The name of the resource that is unique within a resource group. This name can be used to access the resource. |
properties.access |
The access type of the rule. |
|
properties.communities |
string[] |
The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. |
properties.provisioningState |
The provisioning state of the route filter rule resource. |
|
properties.routeFilterRuleType |
The rule type of the rule. |
RouteFilterRuleType
The rule type of the rule.
Name | Type | Description |
---|---|---|
Community |
string |