routing_rules

Creates, updates, deletes, gets or lists a routing_rules resource.

Overview

Name	routing_rules
Type	Resource
Id	azure.network.routing_rules

Fields

The following fields are returned by SELECT queries:

get

Successful operation

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Indicates the properties of the routing rule
systemData	object	The system metadata related to this resource.
type	string	Resource type.

list

Successful operation

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Indicates the properties of the routing rule
systemData	object	The system metadata related to this resource.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets a network manager routing configuration routing rule.
list	select			List all network manager routing configuration routing rules.
create_or_update	insert			Creates or updates an routing rule.
delete	delete		force	Deletes a routing rule.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
force	boolean	Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.

SELECT examples

get

Gets a network manager routing configuration routing rule.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.routing_rules
;

list

List all network manager routing configuration routing rules.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.routing_rules
;

INSERT examples

create_or_update

Creates or updates an routing rule.

INSERT INTO azure.network.routing_rules (
data__properties
)
SELECT 
'{{ properties }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: routing_rules
  props:
    - name: properties
      value: object
      description: |
        Indicates the properties of the routing rule

DELETE examples

delete

Deletes a routing rule.

DELETE FROM azure.network.routing_rules
WHERE force = '{{ force }}'
;