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

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
appliesTo	array	Groups for configuration. Required.
description	string	A description of the routing rule collection.
disableBgpRoutePropagation	string	Determines whether BGP route propagation is enabled. Defaults to true. Known values are: "False" and "True". (False, True)
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	Unique identifier for this resource.
systemData	object	The system metadata related to this resource.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
appliesTo	array	Groups for configuration. Required.
description	string	A description of the routing rule collection.
disableBgpRoutePropagation	string	Determines whether BGP route propagation is enabled. Defaults to true. Known values are: "False" and "True". (False, True)
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	Unique identifier for this resource.
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	resource_group_name, network_manager_name, configuration_name, rule_collection_name, subscription_id		Gets a network manager routing configuration rule collection.
list	select	resource_group_name, network_manager_name, configuration_name, subscription_id	$top, $skipToken	Lists all the rule collections in a routing configuration, in a paginated format.
create_or_update	insert	resource_group_name, network_manager_name, configuration_name, rule_collection_name, subscription_id		Creates or updates a routing rule collection.
create_or_update	replace	resource_group_name, network_manager_name, configuration_name, rule_collection_name, subscription_id		Creates or updates a routing rule collection.
delete	delete	resource_group_name, network_manager_name, configuration_name, rule_collection_name, subscription_id	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
configuration_name	string	The name of the network manager Routing Configuration. Required.
network_manager_name	string	The name of the network manager. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
rule_collection_name	string	The name of the network manager routing Configuration rule collection. Required.
subscription_id	string
$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. Default value is None.
$top	integer	An optional query parameter which specifies the maximum number of records to be returned by the server. Default value is None.
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. Default value is None.

SELECT examples

get

Gets a network manager routing configuration rule collection.

SELECT
id,
name,
appliesTo,
description,
disableBgpRoutePropagation,
etag,
provisioningState,
resourceGuid,
systemData,
type
FROM azure.network.routing_rule_collections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND configuration_name = '{{ configuration_name }}' -- required
AND rule_collection_name = '{{ rule_collection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
appliesTo,
description,
disableBgpRoutePropagation,
etag,
provisioningState,
resourceGuid,
systemData,
type
FROM azure.network.routing_rule_collections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND configuration_name = '{{ configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
properties,
resource_group_name,
network_manager_name,
configuration_name,
rule_collection_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_manager_name }}',
'{{ configuration_name }}',
'{{ rule_collection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: routing_rule_collections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the routing_rule_collections resource.
  - name: network_manager_name
    value: "{{ network_manager_name }}"
    description: Required parameter for the routing_rule_collections resource.
  - name: configuration_name
    value: "{{ configuration_name }}"
    description: Required parameter for the routing_rule_collections resource.
  - name: rule_collection_name
    value: "{{ rule_collection_name }}"
    description: Required parameter for the routing_rule_collections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the routing_rule_collections resource.
  - name: properties
    description: |
      Indicates the properties for the network manager routing rule collection.
    value:
      description: "{{ description }}"
      provisioningState: "{{ provisioningState }}"
      resourceGuid: "{{ resourceGuid }}"
      appliesTo:
        - networkGroupId: "{{ networkGroupId }}"
      disableBgpRoutePropagation: "{{ disableBgpRoutePropagation }}"

REPLACE examples

create_or_update

Creates or updates a routing rule collection.

REPLACE azure.network.routing_rule_collections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND configuration_name = '{{ configuration_name }}' --required
AND rule_collection_name = '{{ rule_collection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes an routing rule collection.

DELETE FROM azure.network.routing_rule_collections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND configuration_name = '{{ configuration_name }}' --required
AND rule_collection_name = '{{ rule_collection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND force = '{{ force }}'
;