ip_communities

Creates, updates, deletes, gets or lists an ip_communities resource.

Overview

Name	ip_communities
Type	Resource
Id	azure.managed_network_fabric.ip_communities

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

list_by_resource_group

Lists all IP Communities under the resource group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

list_by_subscription

Lists all IP Communities under the subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, ipCommunityName		Implements an IP Community GET method.
list_by_resource_group	select	subscriptionId, resourceGroupName		Implements IP Communities list by resource group GET method.
list_by_subscription	select	subscriptionId		Implements IP Communities list by subscription GET method.
create	insert	subscriptionId, resourceGroupName, ipCommunityName, data__properties		Implements an IP Community PUT method.
update	update	subscriptionId, resourceGroupName, ipCommunityName		API to update certain properties of the IP Community resource.
delete	delete	subscriptionId, resourceGroupName, ipCommunityName		Implements IP Community DELETE method.

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
ipCommunityName	string	Name of the IP Community.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Implements an IP Community GET method.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.ip_communities
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND ipCommunityName = '{{ ipCommunityName }}' -- required
;

list_by_resource_group

Implements IP Communities list by resource group GET method.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.ip_communities
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Implements IP Communities list by subscription GET method.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.ip_communities
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Implements an IP Community PUT method.

INSERT INTO azure.managed_network_fabric.ip_communities (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
ipCommunityName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ ipCommunityName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: ip_communities
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the ip_communities resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the ip_communities resource.
    - name: ipCommunityName
      value: string
      description: Required parameter for the ip_communities resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

API to update certain properties of the IP Community resource.

UPDATE azure.managed_network_fabric.ip_communities
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND ipCommunityName = '{{ ipCommunityName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Implements IP Community DELETE method.

DELETE FROM azure.managed_network_fabric.ip_communities
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND ipCommunityName = '{{ ipCommunityName }}' --required
;