access_control_lists

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

Overview

Name	access_control_lists
Type	Resource
Id	azure_extras.managed_network_fabric.access_control_lists

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.
aclType	string	Access Control List (ACL) Type. Known values are: "ControlPlaneTrafficPolicy", "Tenant", "Management", and "ControlPlaneAcl". (ControlPlaneTrafficPolicy, Tenant, Management, ControlPlaneAcl)
aclsUrl	string	Access Control List file URL.
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)
configurationType	string	Input method to configure Access Control List. Required. Known values are: "File" and "Inline". (File, Inline)
controlPlaneAclConfiguration	array	Access Control List (ACL) configurations.
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)
deviceRole	string	Device Role. Known values are: "CE", "ToR", "NPB", and "ManagementSwitch". (CE, ToR, NPB, ManagementSwitch)
dynamicMatchConfigurations	array	List of dynamic match configurations.
globalAccessControlListActions	object	Global Access Control List (ACL) actions.
lastOperation	object	Details of the last operation performed on the resource.
lastSyncedTime	string (date-time)	The last synced timestamp.
location	string	The geo-location where the resource lives. Required.
matchConfigurations	array	List of match configurations.
networkFabricIds	array	Associated Network Fabric Resource IDs.
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.
aclType	string	Access Control List (ACL) Type. Known values are: "ControlPlaneTrafficPolicy", "Tenant", "Management", and "ControlPlaneAcl". (ControlPlaneTrafficPolicy, Tenant, Management, ControlPlaneAcl)
aclsUrl	string	Access Control List file URL.
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)
configurationType	string	Input method to configure Access Control List. Required. Known values are: "File" and "Inline". (File, Inline)
controlPlaneAclConfiguration	array	Access Control List (ACL) configurations.
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)
deviceRole	string	Device Role. Known values are: "CE", "ToR", "NPB", and "ManagementSwitch". (CE, ToR, NPB, ManagementSwitch)
dynamicMatchConfigurations	array	List of dynamic match configurations.
globalAccessControlListActions	object	Global Access Control List (ACL) actions.
lastOperation	object	Details of the last operation performed on the resource.
lastSyncedTime	string (date-time)	The last synced timestamp.
location	string	The geo-location where the resource lives. Required.
matchConfigurations	array	List of match configurations.
networkFabricIds	array	Associated Network Fabric Resource IDs.
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.
aclType	string	Access Control List (ACL) Type. Known values are: "ControlPlaneTrafficPolicy", "Tenant", "Management", and "ControlPlaneAcl". (ControlPlaneTrafficPolicy, Tenant, Management, ControlPlaneAcl)
aclsUrl	string	Access Control List file URL.
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)
configurationType	string	Input method to configure Access Control List. Required. Known values are: "File" and "Inline". (File, Inline)
controlPlaneAclConfiguration	array	Access Control List (ACL) configurations.
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)
deviceRole	string	Device Role. Known values are: "CE", "ToR", "NPB", and "ManagementSwitch". (CE, ToR, NPB, ManagementSwitch)
dynamicMatchConfigurations	array	List of dynamic match configurations.
globalAccessControlListActions	object	Global Access Control List (ACL) actions.
lastOperation	object	Details of the last operation performed on the resource.
lastSyncedTime	string (date-time)	The last synced timestamp.
location	string	The geo-location where the resource lives. Required.
matchConfigurations	array	List of match configurations.
networkFabricIds	array	Associated Network Fabric Resource IDs.
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, access_control_list_name, subscription_id		Implements Access Control List GET method.
list_by_resource_group	select	resource_group_name, subscription_id		Implements AccessControlLists list by resource group GET method.
list_by_subscription	select	subscription_id		Implements AccessControlLists list by subscription GET method.
create	insert	resource_group_name, access_control_list_name, subscription_id, location, properties		Implements Access Control List PUT method.
update	update	resource_group_name, access_control_list_name, subscription_id		API to update certain properties of the Access Control List resource.
delete	delete	resource_group_name, access_control_list_name, subscription_id		Implements Access Control List DELETE method.
update_administrative_state	exec	resource_group_name, access_control_list_name, subscription_id		Implements the operation to the underlying resources.
resync	exec	resource_group_name, access_control_list_name, subscription_id		Implements the operation to the underlying resources.
validate_configuration	exec	resource_group_name, access_control_list_name, subscription_id		Implements the operation to the underlying 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
access_control_list_name	string	Name of the Access Control List. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Implements Access Control List GET method.

SELECT
id,
name,
aclType,
aclsUrl,
administrativeState,
annotation,
configurationState,
configurationType,
controlPlaneAclConfiguration,
defaultAction,
deviceRole,
dynamicMatchConfigurations,
globalAccessControlListActions,
lastOperation,
lastSyncedTime,
location,
matchConfigurations,
networkFabricIds,
provisioningState,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.access_control_lists
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND access_control_list_name = '{{ access_control_list_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Implements AccessControlLists list by resource group GET method.

SELECT
id,
name,
aclType,
aclsUrl,
administrativeState,
annotation,
configurationState,
configurationType,
controlPlaneAclConfiguration,
defaultAction,
deviceRole,
dynamicMatchConfigurations,
globalAccessControlListActions,
lastOperation,
lastSyncedTime,
location,
matchConfigurations,
networkFabricIds,
provisioningState,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.access_control_lists
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Implements AccessControlLists list by subscription GET method.

SELECT
id,
name,
aclType,
aclsUrl,
administrativeState,
annotation,
configurationState,
configurationType,
controlPlaneAclConfiguration,
defaultAction,
deviceRole,
dynamicMatchConfigurations,
globalAccessControlListActions,
lastOperation,
lastSyncedTime,
location,
matchConfigurations,
networkFabricIds,
provisioningState,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.access_control_lists
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Implements Access Control List PUT method.

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

Manifest

# Description fields are for documentation purposes
- name: access_control_lists
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the access_control_lists resource.
  - name: access_control_list_name
    value: "{{ access_control_list_name }}"
    description: Required parameter for the access_control_lists resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the access_control_lists 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 Access ControlList properties. Required.
    value:
      annotation: "{{ annotation }}"
      configurationType: "{{ configurationType }}"
      aclsUrl: "{{ aclsUrl }}"
      defaultAction: "{{ defaultAction }}"
      matchConfigurations:
        - matchConfigurationName: "{{ matchConfigurationName }}"
          sequenceNumber: {{ sequenceNumber }}
          ipAddressType: "{{ ipAddressType }}"
          matchConditions: "{{ matchConditions }}"
          actions: "{{ actions }}"
      dynamicMatchConfigurations:
        - ipGroups: "{{ ipGroups }}"
          vlanGroups: "{{ vlanGroups }}"
          portGroups: "{{ portGroups }}"
      lastSyncedTime: "{{ lastSyncedTime }}"
      aclType: "{{ aclType }}"
      deviceRole: "{{ deviceRole }}"
      globalAccessControlListActions:
        enableCount: "{{ enableCount }}"
      lastOperation:
        details: "{{ details }}"
      networkFabricIds:
        - "{{ networkFabricIds }}"
      controlPlaneAclConfiguration:
        - ipAddressType: "{{ ipAddressType }}"
          matchConfigurations: "{{ matchConfigurations }}"
      configurationState: "{{ configurationState }}"
      provisioningState: "{{ provisioningState }}"
      administrativeState: "{{ administrativeState }}"

UPDATE examples

update

API to update certain properties of the Access Control List resource.

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

DELETE examples

delete

Implements Access Control List DELETE method.

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

Lifecycle Methods

update_administrative_state

Implements the operation to the underlying resources.

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

resync

Implements the operation to the underlying resources.

EXEC azure_extras.managed_network_fabric.access_control_lists.resync 
@resource_group_name='{{ resource_group_name }}' --required, 
@access_control_list_name='{{ access_control_list_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

validate_configuration

Implements the operation to the underlying resources.

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