Skip to content

Latest commit

 

History

History
403 lines (312 loc) · 17.6 KB

azure_route_filter.md

File metadata and controls

403 lines (312 loc) · 17.6 KB
Raw

Document: "routeFilter"

Path: "https://github.com/Azure/azure-rest-api-specs/blob/2fbb5118cd34f412a51d9bc8a274224b216763cf/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/routeFilter.json")

RouteFilter

Route Filter Resource.

azure_route_filter {
  api_version => "api_version",
  id => "id (optional)",
  location => "location (optional)",
  properties => $azure_route_filter_properties_format
  resource_group_name => "resource_group_name",
  route_filter_parameters => "routeFilterParameters",
  subscription_id => "subscription_id",
  tags => "tags (optional)",
}
Name Type Required Description
api_version String true Client API version.
id String false Resource ID.
location String false Resource location.
properties RouteFilterPropertiesFormat false Properties of the route filter.
resource_group_name String true The name of the resource group.
route_filter_parameters Hash true Parameters supplied to the create or update route filter operation.
subscription_id String true The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
tags Hash false Resource tags.

RouteFilterPropertiesFormat

Route Filter Resource.

$azure_route_filter_properties_format = {
  ipv6Peerings => $azure_express_route_circuit_peering
  peerings => $azure_express_route_circuit_peering
  rules => $azure_route_filter_rule
}
Name Type Required Description
ipv6Peerings ExpressRouteCircuitPeering false A collection of references to express route circuit ipv6 peerings.
peerings ExpressRouteCircuitPeering false A collection of references to express route circuit peerings.
rules RouteFilterRule false Collection of RouteFilterRules contained within a route filter.

ExpressRouteCircuitPeering

Peering in an ExpressRouteCircuit resource.

$azure_express_route_circuit_peering = {
  id => "id (optional)",
  name => "name (optional)",
  properties => $azure_express_route_circuit_peering_properties_format
}
Name Type Required Description
id String false Resource ID.
name String false Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
properties ExpressRouteCircuitPeeringPropertiesFormat false Properties of the express route circuit peering.

ExpressRouteCircuitPeeringPropertiesFormat

Properties of the express route circuit peering.

$azure_express_route_circuit_peering_properties_format = {
  azureASN => "1234 (optional)",
  connections => $azure_express_route_circuit_connection
  expressRouteConnection => $azure_express_route_connection_id
  gatewayManagerEtag => "gatewayManagerEtag (optional)",
  ipv6PeeringConfig => $azure_ipv6_express_route_circuit_peering_config
  lastModifiedBy => "lastModifiedBy (optional)",
  microsoftPeeringConfig => $azure_express_route_circuit_peering_config
  peerASN => "1234 (optional)",
  peeredConnections => $azure_peer_express_route_circuit_connection
  peeringType => $azure_express_route_peering_type
  primaryAzurePort => "primaryAzurePort (optional)",
  primaryPeerAddressPrefix => "primaryPeerAddressPrefix (optional)",
  provisioningState => "provisioningState (optional)",
  routeFilter => $azure_sub_resource
  secondaryAzurePort => "secondaryAzurePort (optional)",
  secondaryPeerAddressPrefix => "secondaryPeerAddressPrefix (optional)",
  sharedKey => "sharedKey (optional)",
  state => $azure_express_route_peering_state
  stats => $azure_express_route_circuit_stats
  vlanId => "1234 (optional)",
}
Name Type Required Description
azureASN Integer false The Azure ASN.
connections ExpressRouteCircuitConnection false The list of circuit connections associated with Azure Private Peering for this circuit.
expressRouteConnection ExpressRouteConnectionId false The ExpressRoute connection.
gatewayManagerEtag String false The GatewayManager Etag.
ipv6PeeringConfig Ipv6ExpressRouteCircuitPeeringConfig false The IPv6 peering configuration.
lastModifiedBy String false Gets whether the provider or the customer last modified the peering.
microsoftPeeringConfig ExpressRouteCircuitPeeringConfig false The Microsoft peering configuration.
peerASN Integer false The peer ASN.
peeredConnections PeerExpressRouteCircuitConnection false The list of peered circuit connections associated with Azure Private Peering for this circuit.
peeringType ExpressRoutePeeringType false The peering type.
primaryAzurePort String false The primary port.
primaryPeerAddressPrefix String false The primary address prefix.
provisioningState String false Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
routeFilter SubResource false The reference of the RouteFilter resource.
secondaryAzurePort String false The secondary port.
secondaryPeerAddressPrefix String false The secondary address prefix.
sharedKey String false The shared key.
state ExpressRoutePeeringState false The peering state.
stats ExpressRouteCircuitStats false Gets peering stats.
vlanId Integer false The VLAN ID.

ExpressRouteCircuitConnection

Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.

$azure_express_route_circuit_connection = {
  id => "id (optional)",
  name => "name (optional)",
  properties => $azure_express_route_circuit_connection_properties_format
}
Name Type Required Description
id String false Resource ID.
name String false Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
properties ExpressRouteCircuitConnectionPropertiesFormat false Properties of the express route circuit connection.

ExpressRouteCircuitConnectionPropertiesFormat

Properties of the express route circuit connection.

$azure_express_route_circuit_connection_properties_format = {
  addressPrefix => "addressPrefix (optional)",
  authorizationKey => "authorizationKey (optional)",
  circuitConnectionStatus => $azure_circuit_connection_status
  expressRouteCircuitPeering => $azure_sub_resource
  peerExpressRouteCircuitPeering => $azure_sub_resource
}
Name Type Required Description
addressPrefix String false /29 IP address space to carve out Customer addresses for tunnels.
authorizationKey String false The authorization key.
circuitConnectionStatus CircuitConnectionStatus false Express Route Circuit connection state.
expressRouteCircuitPeering SubResource false Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
peerExpressRouteCircuitPeering SubResource false Reference to Express Route Circuit Private Peering Resource of the peered circuit.

CircuitConnectionStatus

Express Route Circuit connection state.

$azure_circuit_connection_status = {
}
Name Type Required Description

SubResource

Reference to another subresource.

$azure_sub_resource = {
  id => "id (optional)",
}
Name Type Required Description
id String false Resource ID.

ExpressRouteConnectionId

The ID of the ExpressRouteConnection.

$azure_express_route_connection_id = {
}
Name Type Required Description

Ipv6ExpressRouteCircuitPeeringConfig

Contains IPv6 peering config.

$azure_ipv6_express_route_circuit_peering_config = {
  microsoftPeeringConfig => $azure_express_route_circuit_peering_config
  primaryPeerAddressPrefix => "primaryPeerAddressPrefix (optional)",
  routeFilter => $azure_sub_resource
  secondaryPeerAddressPrefix => "secondaryPeerAddressPrefix (optional)",
  state => "state (optional)",
}
Name Type Required Description
microsoftPeeringConfig ExpressRouteCircuitPeeringConfig false The Microsoft peering configuration.
primaryPeerAddressPrefix String false The primary address prefix.
routeFilter SubResource false The reference of the RouteFilter resource.
secondaryPeerAddressPrefix String false The secondary address prefix.
state String false The state of peering.

ExpressRouteCircuitPeeringConfig

Specifies the peering configuration.

$azure_express_route_circuit_peering_config = {
  advertisedCommunities => "advertisedCommunities (optional)",
  advertisedPublicPrefixes => "advertisedPublicPrefixes (optional)",
  advertisedPublicPrefixesState => "advertisedPublicPrefixesState (optional)",
  customerASN => "1234 (optional)",
  legacyMode => "1234 (optional)",
  routingRegistryName => "routingRegistryName (optional)",
}
Name Type Required Description
advertisedCommunities Array false The communities of bgp peering. Specified for microsoft peering.
advertisedPublicPrefixes Array false The reference of AdvertisedPublicPrefixes.
advertisedPublicPrefixesState String false The advertised public prefix state of the Peering resource.
customerASN Integer false The CustomerASN of the peering.
legacyMode Integer false The legacy mode of the peering.
routingRegistryName String false The RoutingRegistryName of the configuration.

PeerExpressRouteCircuitConnection

Peer Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.

$azure_peer_express_route_circuit_connection = {
  id => "id (optional)",
  name => "name (optional)",
  properties => $azure_peer_express_route_circuit_connection_properties_format
}
Name Type Required Description
id String false Resource ID.
name String false Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
properties PeerExpressRouteCircuitConnectionPropertiesFormat false Properties of the peer express route circuit connection.

PeerExpressRouteCircuitConnectionPropertiesFormat

Properties of the peer express route circuit connection.

$azure_peer_express_route_circuit_connection_properties_format = {
  addressPrefix => "addressPrefix (optional)",
  authResourceGuid => "authResourceGuid (optional)",
  circuitConnectionStatus => $azure_circuit_connection_status
  connectionName => "connectionName (optional)",
  expressRouteCircuitPeering => $azure_sub_resource
  peerExpressRouteCircuitPeering => $azure_sub_resource
}
Name Type Required Description
addressPrefix String false /29 IP address space to carve out Customer addresses for tunnels.
authResourceGuid String false The resource guid of the authorization used for the express route circuit connection.
circuitConnectionStatus CircuitConnectionStatus false Express Route Circuit connection state.
connectionName String false The name of the express route circuit connection resource.
expressRouteCircuitPeering SubResource false Reference to Express Route Circuit Private Peering Resource of the circuit.
peerExpressRouteCircuitPeering SubResource false Reference to Express Route Circuit Private Peering Resource of the peered circuit.

ExpressRoutePeeringType

The peering type.

$azure_express_route_peering_type = {
}
Name Type Required Description

ExpressRoutePeeringState

The state of peering.

$azure_express_route_peering_state = {
}
Name Type Required Description

ExpressRouteCircuitStats

Contains stats associated with the peering.

$azure_express_route_circuit_stats = {
  primarybytesIn => "1234 (optional)",
  primarybytesOut => "1234 (optional)",
  secondarybytesIn => "1234 (optional)",
  secondarybytesOut => "1234 (optional)",
}
Name Type Required Description
primarybytesIn Integer false Gets BytesIn of the peering.
primarybytesOut Integer false Gets BytesOut of the peering.
secondarybytesIn Integer false Gets BytesIn of the peering.
secondarybytesOut Integer false Gets BytesOut of the peering.

RouteFilterRule

Route Filter Rule Resource.

$azure_route_filter_rule = {
  id => "id (optional)",
  location => "location (optional)",
  name => "name (optional)",
  properties => $azure_route_filter_rule_properties_format
}
Name Type Required Description
id String false Resource ID.
location String false Resource location.
name String false The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties RouteFilterRulePropertiesFormat false Properties of the route filter rule.

RouteFilterRulePropertiesFormat

Route Filter Rule Resource.

$azure_route_filter_rule_properties_format = {
  access => $azure_access
  communities => "communities",
  routeFilterRuleType => "routeFilterRuleType",
}
Name Type Required Description
access Access true The access type of the rule.
communities Array true The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
routeFilterRuleType String true The rule type of the rule.

Access

Access to be allowed or denied.

$azure_access = {
}
Name Type Required Description

CRUD operations

Here is a list of endpoints that we use to create, read, update and delete the RouteFilter

Operation Path Verb Description OperationID
Create /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Network/routeFilters/%{route_filter_name} Put Creates or updates a route filter in a specified resource group. RouteFilters_CreateOrUpdate
List - list all /subscriptions/%{subscription_id}/providers/Microsoft.Network/routeFilters Get Gets all route filters in a subscription. RouteFilters_List
List - get one /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Network/routeFilters/%{route_filter_name} Get Gets the specified route filter. RouteFilters_Get
List - get list using params /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Network/routeFilters Get Gets all route filters in a resource group. RouteFilters_ListByResourceGroup
Update /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Network/routeFilters/%{route_filter_name} Put Creates or updates a route filter in a specified resource group. RouteFilters_CreateOrUpdate
Delete /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Network/routeFilters/%{route_filter_name} Delete Deletes the specified route filter. RouteFilters_Delete