route_policies

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

Overview

Name	route_policies
Type	Resource
Id	azure_extras.managed_network_fabric.route_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
addressFamilyType	string	AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy. Known values are: "IPv4" and "IPv6". (IPv4, IPv6)
administrativeState	string	Administrative state of the resource. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
defaultAction	string	Default action that needs to be applied when no condition is matched. Example: Permit | Deny. Known values are: "Permit" and "Deny". (Permit, Deny)
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
networkFabricId	string	Arm Resource ID of Network Fabric. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
statements	array	Route Policy statements. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
addressFamilyType	string	AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy. Known values are: "IPv4" and "IPv6". (IPv4, IPv6)
administrativeState	string	Administrative state of the resource. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
defaultAction	string	Default action that needs to be applied when no condition is matched. Example: Permit | Deny. Known values are: "Permit" and "Deny". (Permit, Deny)
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
networkFabricId	string	Arm Resource ID of Network Fabric. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
statements	array	Route Policy statements. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
addressFamilyType	string	AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy. Known values are: "IPv4" and "IPv6". (IPv4, IPv6)
administrativeState	string	Administrative state of the resource. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
defaultAction	string	Default action that needs to be applied when no condition is matched. Example: Permit | Deny. Known values are: "Permit" and "Deny". (Permit, Deny)
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
networkFabricId	string	Arm Resource ID of Network Fabric. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
statements	array	Route Policy statements. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, route_policy_name, subscription_id		Implements Route Policy GET method.
list_by_resource_group	select	resource_group_name, subscription_id		Implements RoutePolicies list by resource group GET method.
list_by_subscription	select	subscription_id		Implements RoutePolicies list by subscription GET method.
create	insert	resource_group_name, route_policy_name, subscription_id, location, properties		Implements Route Policy PUT method.
update	update	resource_group_name, route_policy_name, subscription_id		API to update certain properties of the Route Policy resource.
delete	delete	resource_group_name, route_policy_name, subscription_id		Implements Route Policy DELETE method.
update_administrative_state	exec	resource_group_name, route_policy_name, subscription_id		Updated the admin state for this Route Policy.
validate_configuration	exec	resource_group_name, route_policy_name, subscription_id		Validates the configuration of the resources.
commit_configuration	exec	resource_group_name, route_policy_name, subscription_id		Commits the configuration of the given resources.

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.
route_policy_name	string	Name of the Route Policy. Required.
subscription_id	string

SELECT examples

get

Implements Route Policy GET method.

SELECT
id,
name,
addressFamilyType,
administrativeState,
annotation,
configurationState,
defaultAction,
lastOperation,
location,
networkFabricId,
provisioningState,
statements,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.route_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND route_policy_name = '{{ route_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Implements RoutePolicies list by resource group GET method.

SELECT
id,
name,
addressFamilyType,
administrativeState,
annotation,
configurationState,
defaultAction,
lastOperation,
location,
networkFabricId,
provisioningState,
statements,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.route_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Implements RoutePolicies list by subscription GET method.

SELECT
id,
name,
addressFamilyType,
administrativeState,
annotation,
configurationState,
defaultAction,
lastOperation,
location,
networkFabricId,
provisioningState,
statements,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.route_policies
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Implements Route Policy PUT method.

INSERT INTO azure_extras.managed_network_fabric.route_policies (
tags,
location,
properties,
resource_group_name,
route_policy_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ route_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: route_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the route_policies resource.
  - name: route_policy_name
    value: "{{ route_policy_name }}"
    description: Required parameter for the route_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the route_policies resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The RoutePolicy properties. Required.
    value:
      annotation: "{{ annotation }}"
      defaultAction: "{{ defaultAction }}"
      statements:
        - annotation: "{{ annotation }}"
          sequenceNumber: {{ sequenceNumber }}
          condition:
            ipCommunityIds:
              - "{{ ipCommunityIds }}"
            ipExtendedCommunityIds:
              - "{{ ipExtendedCommunityIds }}"
            type: "{{ type }}"
            ipPrefixId: "{{ ipPrefixId }}"
          action:
            localPreference: {{ localPreference }}
            actionType: "{{ actionType }}"
            ipCommunityProperties:
              add:
                ipCommunityIds: "{{ ipCommunityIds }}"
              delete:
                ipCommunityIds: "{{ ipCommunityIds }}"
              set:
                ipCommunityIds: "{{ ipCommunityIds }}"
            ipExtendedCommunityProperties:
              add:
                ipExtendedCommunityIds: "{{ ipExtendedCommunityIds }}"
              delete:
                ipExtendedCommunityIds: "{{ ipExtendedCommunityIds }}"
              set:
                ipExtendedCommunityIds: "{{ ipExtendedCommunityIds }}"
      networkFabricId: "{{ networkFabricId }}"
      addressFamilyType: "{{ addressFamilyType }}"
      lastOperation:
        details: "{{ details }}"
      configurationState: "{{ configurationState }}"
      provisioningState: "{{ provisioningState }}"
      administrativeState: "{{ administrativeState }}"

UPDATE examples

update

API to update certain properties of the Route Policy resource.

UPDATE azure_extras.managed_network_fabric.route_policies
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND route_policy_name = '{{ route_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Implements Route Policy DELETE method.

DELETE FROM azure_extras.managed_network_fabric.route_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND route_policy_name = '{{ route_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

update_administrative_state

Updated the admin state for this Route Policy.

EXEC azure_extras.managed_network_fabric.route_policies.update_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@route_policy_name='{{ route_policy_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceIds": "{{ resourceIds }}", 
"state": "{{ state }}"
}'
;

validate_configuration

Validates the configuration of the resources.

EXEC azure_extras.managed_network_fabric.route_policies.validate_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@route_policy_name='{{ route_policy_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

commit_configuration

Commits the configuration of the given resources.

EXEC azure_extras.managed_network_fabric.route_policies.commit_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@route_policy_name='{{ route_policy_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;