routing_rule_collections

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

Overview

Name	routing_rule_collections
Type	Resource
Id	azure.network.routing_rule_collections

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 for the network manager routing rule collection.
systemData	object	The system metadata related to this resource.
type	string	Resource type.

list

Get successful. The operation returns all ruleCollections in the specified routing configuration, in a paginated format

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 for the network manager routing rule collection.
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 rule collection.
list	select	subscriptionId, resourceGroupName, networkManagerName, configurationName	$top, $skipToken	Lists all the rule collections in a routing configuration, in a paginated format.
create_or_update	insert			Creates or updates a routing rule collection.
delete	delete		force	Deletes an routing rule collection.

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
configurationName	string	The name of the network manager Routing Configuration.
networkManagerName	string	The name of the network manager.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$skipToken	string	SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
$top	integer (int32)	An optional query parameter which specifies the maximum number of records to be returned by the server.
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 rule collection.

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

list

Lists all the rule collections in a routing configuration, in a paginated format.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.routing_rule_collections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkManagerName = '{{ networkManagerName }}' -- required
AND configurationName = '{{ configurationName }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates a routing rule collection.

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

Manifest

# Description fields are for documentation purposes
- name: routing_rule_collections
  props:
    - name: properties
      value: object
      description: |
        Indicates the properties for the network manager routing rule collection.

DELETE examples

delete

Deletes an routing rule collection.

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