exec.azurerm.network.route

Azure Resource Manager (ARM) Network Route Execution Module

New in version 1.0.0.

Changed in version 4.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct in order to work properly.

Required provider parameters:

if using username and password:
  • subscription_id
  • username
  • password
if using a service principal:
  • subscription_id
  • tenant
  • client_id
  • secret

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:

  • AZURE_PUBLIC_CLOUD (default)
  • AZURE_CHINA_CLOUD
  • AZURE_US_GOV_CLOUD
  • AZURE_GERMAN_CLOUD
idem_azurerm.exec.azurerm.network.route.create_or_update(hub, ctx, name, route_table, resource_group, address_prefix, next_hop_type, next_hop_ip_address=None, **kwargs)

New in version 1.0.0.

Create or update a route within a specified route table.

Parameters:
  • name – The name of the route to create.
  • route_table – The name of the route table containing the route.
  • resource_group – The resource group name assigned to the route table.
  • address_prefix – The destination CIDR to which the route applies.
  • next_hop_type – The type of Azure hop the packet should be sent to. Possible values are: ‘VnetLocal’, ‘VirtualNetworkGateway’, ‘Internet’, ‘VirtualAppliance’, and ‘None’.
  • next_hop_ip_address – IP address to which packets should be forwarded. Next hop values are only allowed in routes where the next_hop_type is ‘VirtualAppliance’.

CLI Example:

azurerm.network.route.create_or_update test_name '10.0.0.0/8' test_rt_table test_group
idem_azurerm.exec.azurerm.network.route.delete(hub, ctx, name, route_table, resource_group, **kwargs)

New in version 1.0.0.

Delete a route from a route table.

Parameters:
  • name – The route to delete.
  • route_table – The route table containing the route.
  • resource_group – The resource group name assigned to the route table.

CLI Example:

azurerm.network.route.delete test_name test_rt_table test_group
idem_azurerm.exec.azurerm.network.route.filter_create_or_update(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Create or update a route filter within a specified resource group.

Parameters:
  • name – The name of the route filter to create.
  • resource_group – The resource group name assigned to the route filter.

CLI Example:

azurerm.network.route.filter_create_or_update test_name test_group
idem_azurerm.exec.azurerm.network.route.filter_delete(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Delete a route filter.

Parameters:
  • name – The name of the route filter to delete.
  • resource_group – The resource group name assigned to the route filter.

CLI Example:

azurerm.network.route.filter_delete test_name test_group
idem_azurerm.exec.azurerm.network.route.filter_get(hub, ctx, name, resource_group, expand=None, **kwargs)

New in version 1.0.0.

Changed in version 4.0.0.

Get details about a specific route filter.

Parameters:
  • name – The name of the route table to query.
  • resource_group – The resource group name assigned to the route filter.
  • expand – Expands referenced express route bgp peering resources.

CLI Example:

azurerm.network.route.filter_get test_name test_group
idem_azurerm.exec.azurerm.network.route.filter_rule_create_or_update(hub, ctx, name, access, communities, route_filter, resource_group, **kwargs)

New in version 1.0.0.

Create or update a rule within a specified route filter.

Parameters:
  • name – The name of the rule to create.
  • access – The access type of the rule. Valid values are ‘Allow’ and ‘Deny’.
  • communities – A list of BGP communities to filter on.
  • route_filter – The name of the route filter containing the rule.
  • resource_group – The resource group name assigned to the route filter.

CLI Example:

azurerm.network.route.filter_rule_create_or_update test_name allow "['12076:51006']" test_filter test_group
idem_azurerm.exec.azurerm.network.route.filter_rule_delete(hub, ctx, name, route_filter, resource_group, **kwargs)

New in version 1.0.0.

Delete a route filter rule.

Parameters:
  • name – The route filter rule to delete.
  • route_filter – The route filter containing the rule.
  • resource_group – The resource group name assigned to the route filter.

CLI Example:

azurerm.network.route.filter_rule_delete test_name test_filter test_group
idem_azurerm.exec.azurerm.network.route.filter_rule_get(hub, ctx, name, route_filter, resource_group, **kwargs)

New in version 1.0.0.

Get details about a specific route filter rule.

Parameters:
  • name – The route filter rule to query.
  • route_filter – The route filter containing the rule.
  • resource_group – The resource group name assigned to the route filter.

CLI Example:

azurerm.network.route.filter_rule_get test_name test_filter test_group
idem_azurerm.exec.azurerm.network.route.filter_rules_list(hub, ctx, route_filter, resource_group, **kwargs)

New in version 1.0.0.

List all routes within a route filter.

Parameters:
  • route_filter – The route filter to query.
  • resource_group – The resource group name assigned to the route filter.

CLI Example:

azurerm.network.route.filter_rules_list test_name test_group
idem_azurerm.exec.azurerm.network.route.filters_list(hub, ctx, resource_group=None, **kwargs)

New in version 1.0.0.

Changed in version 4.0.0.

Lists all route filters in a subscription.

Parameters:resource_group – The name of the resource group to limit the results.

CLI Example:

azurerm.network.route.filters_list
idem_azurerm.exec.azurerm.network.route.get(hub, ctx, name, route_table, resource_group, **kwargs)

New in version 1.0.0.

Get details about a specific route.

Parameters:
  • name – The route to query.
  • route_table – The route table containing the route.
  • resource_group – The resource group name assigned to the route table.

CLI Example:

azurerm.network.route.get test_name test_rt_table test_group
idem_azurerm.exec.azurerm.network.route.list_(hub, ctx, route_table, resource_group, **kwargs)

New in version 4.0.0.

Lists all routes in a route table.

Parameters:
  • route_table – The route table to query.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.network.routes_list test_table test_group
idem_azurerm.exec.azurerm.network.route.table_create_or_update(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Create or update a route table within a specified resource group.

Parameters:
  • name – The name of the route table to create.
  • resource_group – The resource group name assigned to the route table.

CLI Example:

azurerm.network.route.table_create_or_update test_rt_table test_group
idem_azurerm.exec.azurerm.network.route.table_delete(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Delete a route table.

Parameters:
  • name – The name of the route table to delete.
  • resource_group – The resource group name assigned to the route table.

CLI Example:

azurerm.network.route.table_delete test_name test_group
idem_azurerm.exec.azurerm.network.route.table_get(hub, ctx, name, resource_group, expand=None, **kwargs)

New in version 1.0.0.

Get details about a specific route table.

Parameters:
  • name – The name of the route table to query.
  • resource_group – The resource group name assigned to the route table
  • expand – Expands referenced resources.

CLI Example:

azurerm.network.route.table_get test_rt_table test_group
idem_azurerm.exec.azurerm.network.route.table_update_tags(hub, ctx, name, resource_group, tags=None, **kwargs)

New in version 4.0.0.

Updates a route table tags.

Parameters:
  • name – The name of the route table.
  • resource_group – The resource group of the route table.
  • tags – The resource tags to update.

CLI Example:

azurerm.network.route.table_update_tags test_name test_group test_tags
idem_azurerm.exec.azurerm.network.route.tables_list(hub, ctx, resource_group=None, **kwargs)

New in version 1.0.0.

Changed in version 4.0.0.

List all route tables within a subscription.

Parameters:resource_group – The name of the resource group to limit the results.

CLI Example:

azurerm.network.route.tables_list