routing_intent

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

Overview

Name	routing_intent
Type	Resource
Id	azure.network.routing_intent

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the RoutingIntent resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routingPolicies	array	List of routing policies.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the RoutingIntent resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routingPolicies	array	List of routing policies.
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, virtual_hub_name, routing_intent_name, subscription_id		Retrieves the details of a RoutingIntent.
list	select	resource_group_name, virtual_hub_name, subscription_id		Retrieves the details of all RoutingIntent child resources of the VirtualHub.
create_or_update	insert	resource_group_name, virtual_hub_name, routing_intent_name, subscription_id		Creates a RoutingIntent resource if it doesn't exist else updates the existing RoutingIntent.
create_or_update	replace	resource_group_name, virtual_hub_name, routing_intent_name, subscription_id		Creates a RoutingIntent resource if it doesn't exist else updates the existing RoutingIntent.
delete	delete	resource_group_name, virtual_hub_name, routing_intent_name, subscription_id		Deletes a RoutingIntent.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
routing_intent_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
subscription_id	string
virtual_hub_name	string	The name of the VirtualHub. Required.

SELECT examples

get

Retrieves the details of a RoutingIntent.

SELECT
id,
name,
etag,
provisioningState,
routingPolicies,
type
FROM azure.network.routing_intent
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_hub_name = '{{ virtual_hub_name }}' -- required
AND routing_intent_name = '{{ routing_intent_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Retrieves the details of all RoutingIntent child resources of the VirtualHub.

SELECT
id,
name,
etag,
provisioningState,
routingPolicies,
type
FROM azure.network.routing_intent
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_hub_name = '{{ virtual_hub_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a RoutingIntent resource if it doesn't exist else updates the existing RoutingIntent.

INSERT INTO azure.network.routing_intent (
id,
name,
properties,
resource_group_name,
virtual_hub_name,
routing_intent_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ virtual_hub_name }}',
'{{ routing_intent_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: routing_intent
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the routing_intent resource.
  - name: virtual_hub_name
    value: "{{ virtual_hub_name }}"
    description: Required parameter for the routing_intent resource.
  - name: routing_intent_name
    value: "{{ routing_intent_name }}"
    description: Required parameter for the routing_intent resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the routing_intent resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      Properties of the RoutingIntent resource.
    value:
      routingPolicies:
        - name: "{{ name }}"
          destinations: "{{ destinations }}"
          nextHop: "{{ nextHop }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates a RoutingIntent resource if it doesn't exist else updates the existing RoutingIntent.

REPLACE azure.network.routing_intent
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_hub_name = '{{ virtual_hub_name }}' --required
AND routing_intent_name = '{{ routing_intent_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes a RoutingIntent.

DELETE FROM azure.network.routing_intent
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_hub_name = '{{ virtual_hub_name }}' --required
AND routing_intent_name = '{{ routing_intent_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;