routes#

State module for managing Route.

async idem_azure.states.azure.network.routes.present(hub, ctx, name: str, resource_group_name: str, route_table_name: str, route_name: str, address_prefix: str, next_hop_type: str, next_hop_ip_address: str = None, subscription_id: str = None, resource_id: str = None) → dict[source]#

Create or update Routes.

Parameters:

  • name (str) – The identifier for this state.

  • resource_group_name (str) – The name of the resource group.

  • route_table_name (str) – The name of the route table.

  • route_name (str) – The name of the route.

  • address_prefix (str) – Resource location. This field can not be updated.

  • next_hop_type (str) – The type of Azure hop the packet should be sent to.

  • next_hop_ip_address (str, Optional) – The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.

  • subscription_id – Subscription Unique id.

  • resource_id – Route table resource id on Azure.

Returns:

dict

Examples

resource_is_present:
  azure.network.routes.present:
  - name: resource_name
  - resource_group_name: my-resource-group
  - route_name: my-route
  - route_table_name: my-route-table
  - address_prefix:10.0.0.0/25
  - next_hop_ip_address: 10.0.1.0
  - next_hop_type: VirtualAppliance
async idem_azure.states.azure.network.routes.absent(hub, ctx, name: str, resource_group_name: str, route_table_name: str, route_name: str, subscription_id: str = None) → dict[source]#

Delete Routes.

Parameters:

  • name (str) – The identifier for this state.

  • resource_group_name (str) – The name of the resource group.

  • route_name (str) – The name of the route.

  • route_table_name (str) – The name of the route table.

  • subscription_id (str, Optional) – Subscription Unique id.

Returns:

dict

Examples

resource_is_absent:
  azure.network.routes.absent:
    - name: my-resource
    - resource_group_name: my-resource-group-name
    - route_name: my-route
    - route_table_name: my-route-table
async idem_azure.states.azure.network.routes.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function.

Lists all Route under the same subscription.

Returns:

Dict[str, Any]

Examples

$ idem describe azure.network.routes