peering_policies

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

Overview

Name	peering_policies
Type	Resource
Id	azure.managed_network.peering_policies

Fields

The following fields are returned by SELECT queries:

get

Get successful. The operation returns the specified Managed Network Peering Policy resource.

Name	Datatype	Description
properties	object	Gets or sets the properties of a Managed Network Policy

list_by_managed_network

Get successful. The operation returns all Managed Network Peering Policy resources in the specified Managed Network, in a paginated format

Name	Datatype	Description
properties	object	Gets or sets the properties of a Managed Network Policy

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, managedNetworkName, managedNetworkPeeringPolicyName		The Get ManagedNetworkPeeringPolicies operation gets a Managed Network Peering Policy resource, specified by the resource group, Managed Network name, and peering policy name
list_by_managed_network	select	subscriptionId, resourceGroupName, managedNetworkName	$top, $skiptoken	The ListByManagedNetwork PeeringPolicies operation retrieves all the Managed Network Peering Policies in a specified Managed Network, in a paginated format.
create_or_update	insert	subscriptionId, resourceGroupName, managedNetworkName, managedNetworkPeeringPolicyName		The Put ManagedNetworkPeeringPolicies operation creates/updates a new Managed Network Peering Policy
delete	delete	subscriptionId, resourceGroupName, managedNetworkName, managedNetworkPeeringPolicyName		The Delete ManagedNetworkPeeringPolicies operation deletes a Managed Network Peering Policy, specified by the resource group, Managed Network name, and peering policy name

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
managedNetworkName	string	The name of the Managed Network.
managedNetworkPeeringPolicyName	string	The name of the Managed Network Peering Policy.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$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	May be used to limit the number of results in a page for list queries.

SELECT examples

get

The Get ManagedNetworkPeeringPolicies operation gets a Managed Network Peering Policy resource, specified by the resource group, Managed Network name, and peering policy name

SELECT
properties
FROM azure.managed_network.peering_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedNetworkName = '{{ managedNetworkName }}' -- required
AND managedNetworkPeeringPolicyName = '{{ managedNetworkPeeringPolicyName }}' -- required
;

list_by_managed_network

The ListByManagedNetwork PeeringPolicies operation retrieves all the Managed Network Peering Policies in a specified Managed Network, in a paginated format.

SELECT
properties
FROM azure.managed_network.peering_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedNetworkName = '{{ managedNetworkName }}' -- required
AND $top = '{{ $top }}'
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

The Put ManagedNetworkPeeringPolicies operation creates/updates a new Managed Network Peering Policy

INSERT INTO azure.managed_network.peering_policies (
data__properties,
subscriptionId,
resourceGroupName,
managedNetworkName,
managedNetworkPeeringPolicyName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ managedNetworkName }}',
'{{ managedNetworkPeeringPolicyName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: peering_policies
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the peering_policies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the peering_policies resource.
    - name: managedNetworkName
      value: string
      description: Required parameter for the peering_policies resource.
    - name: managedNetworkPeeringPolicyName
      value: string
      description: Required parameter for the peering_policies resource.
    - name: properties
      value: object
      description: |
        Gets or sets the properties of a Managed Network Policy

DELETE examples

delete

The Delete ManagedNetworkPeeringPolicies operation deletes a Managed Network Peering Policy, specified by the resource group, Managed Network name, and peering policy name

DELETE FROM azure.managed_network.peering_policies
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND managedNetworkName = '{{ managedNetworkName }}' --required
AND managedNetworkPeeringPolicyName = '{{ managedNetworkPeeringPolicyName }}' --required
;