routing_intents

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

Overview

Name	routing_intents
Type	Resource
Id	azure.network.routing_intents

Fields

The following fields are returned by SELECT queries:

get

Request successful. Returns the details of the RoutingIntent retrieved.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the RoutingIntent resource.
type	string	Resource type.

list

Request successful. Returns the details of all the RoutingIntent resources for the VirtualHub.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the RoutingIntent resource.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, virtualHubName, routingIntentName		Retrieves the details of a RoutingIntent.
list	select	subscriptionId, resourceGroupName, virtualHubName		Retrieves the details of all RoutingIntent child resources of the VirtualHub.
create_or_update	insert	subscriptionId, resourceGroupName, virtualHubName, routingIntentName		Creates a RoutingIntent resource if it doesn't exist else updates the existing RoutingIntent.
delete	delete	subscriptionId, resourceGroupName, virtualHubName, routingIntentName		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
resourceGroupName	string	The resource group name of the RoutingIntent.
routingIntentName	string	The name of the RoutingIntent.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualHubName	string	The name of the VirtualHub.

SELECT examples

get

Retrieves the details of a RoutingIntent.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.routing_intents
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualHubName = '{{ virtualHubName }}' -- required
AND routingIntentName = '{{ routingIntentName }}' -- required
;

list

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

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.routing_intents
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualHubName = '{{ virtualHubName }}' -- 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_intents (
data__properties,
data__name,
data__id,
subscriptionId,
resourceGroupName,
virtualHubName,
routingIntentName
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ virtualHubName }}',
'{{ routingIntentName }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: routing_intents
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the routing_intents resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the routing_intents resource.
    - name: virtualHubName
      value: string
      description: Required parameter for the routing_intents resource.
    - name: routingIntentName
      value: string
      description: Required parameter for the routing_intents resource.
    - name: properties
      value: object
      description: |
        Properties of the RoutingIntent resource.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes a RoutingIntent.

DELETE FROM azure.network.routing_intents
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualHubName = '{{ virtualHubName }}' --required
AND routingIntentName = '{{ routingIntentName }}' --required
;