ip_communities

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

Overview

Name	ip_communities
Type	Resource
Id	azure_extras.managed_network_fabric.ip_communities

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.
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)
ipCommunityRules	array	List of IP Community Rules. Required.
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 the Network Fabric.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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.
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)
ipCommunityRules	array	List of IP Community Rules. Required.
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 the Network Fabric.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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.
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)
ipCommunityRules	array	List of IP Community Rules. Required.
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 the Network Fabric.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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, ip_community_name, subscription_id		Implements an IP Community GET method.
list_by_resource_group	select	resource_group_name, subscription_id		Implements IP Communities list by resource group GET method.
list_by_subscription	select	subscription_id		Implements IP Communities list by subscription GET method.
create	insert	resource_group_name, ip_community_name, subscription_id, location, properties		Implements an IP Community PUT method.
update	update	resource_group_name, ip_community_name, subscription_id		API to update certain properties of the IP Community resource.
delete	delete	resource_group_name, ip_community_name, subscription_id		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
ip_community_name	string	Name of the IP Community. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Implements an IP Community GET method.

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

list_by_resource_group

Implements IP Communities list by resource group GET method.

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

list_by_subscription

Implements IP Communities list by subscription GET method.

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

INSERT examples

create

Implements an IP Community PUT method.

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

Manifest

# Description fields are for documentation purposes
- name: ip_communities
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the ip_communities resource.
  - name: ip_community_name
    value: "{{ ip_community_name }}"
    description: Required parameter for the ip_communities resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the ip_communities 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 IP Community Properties. Required.
    value:
      annotation: "{{ annotation }}"
      networkFabricId: "{{ networkFabricId }}"
      ipCommunityRules:
        - action: "{{ action }}"
          sequenceNumber: {{ sequenceNumber }}
          wellKnownCommunities: "{{ wellKnownCommunities }}"
          communityMembers: "{{ communityMembers }}"
      lastOperation:
        details: "{{ details }}"
      configurationState: "{{ configurationState }}"
      provisioningState: "{{ provisioningState }}"
      administrativeState: "{{ administrativeState }}"

UPDATE examples

update

API to update certain properties of the IP Community resource.

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

DELETE examples

delete

Implements IP Community DELETE method.

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