network_monitors

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

Overview

Name	network_monitors
Type	Resource
Id	azure_extras.managed_network_fabric.network_monitors

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.
bmpConfiguration	object	BMP Configurations for the Network Fabric.
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)
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provides you the latest status of the NetworkMonitor 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.
bmpConfiguration	object	BMP Configurations for the Network Fabric.
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)
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provides you the latest status of the NetworkMonitor 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.
bmpConfiguration	object	BMP Configurations for the Network Fabric.
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)
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provides you the latest status of the NetworkMonitor 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, network_monitor_name, subscription_id		Implements NetworkMonitor GET method.
list_by_resource_group	select	resource_group_name, subscription_id		Displays NetworkMonitors list by resource group GET method.
list_by_subscription	select	subscription_id		Displays NetworkMonitors list by subscription GET method.
create	insert	resource_group_name, network_monitor_name, subscription_id, location, properties		Creates NetworkMonitor resource.
update	update	resource_group_name, network_monitor_name, subscription_id		API to update certain properties of the NetworkMonitor resource.
delete	delete	resource_group_name, network_monitor_name, subscription_id		Deletes layer 2 connectivity between compute nodes by managed by named NetworkMonitor name.
update_administrative_state	exec	resource_group_name, network_monitor_name, subscription_id		Enables isolation domain across the fabric or on specified racks.

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
network_monitor_name	string	Name of the Network Monitor. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Implements NetworkMonitor GET method.

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

list_by_resource_group

Displays NetworkMonitors list by resource group GET method.

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

list_by_subscription

Displays NetworkMonitors list by subscription GET method.

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

INSERT examples

create

Creates NetworkMonitor resource.

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

Manifest

# Description fields are for documentation purposes
- name: network_monitors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_monitors resource.
  - name: network_monitor_name
    value: "{{ network_monitor_name }}"
    description: Required parameter for the network_monitors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_monitors 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 NetworkMonitor properties. Required.
    value:
      annotation: "{{ annotation }}"
      bmpConfiguration:
        stationConfigurationState: "{{ stationConfigurationState }}"
        scopeResourceId: "{{ scopeResourceId }}"
        stationName: "{{ stationName }}"
        stationIp: "{{ stationIp }}"
        stationPort: {{ stationPort }}
        stationConnectionMode: "{{ stationConnectionMode }}"
        stationConnectionProperties:
          keepaliveIdleTime: {{ keepaliveIdleTime }}
          probeInterval: {{ probeInterval }}
          probeCount: {{ probeCount }}
        stationNetwork: "{{ stationNetwork }}"
        monitoredNetworks:
          - "{{ monitoredNetworks }}"
        exportPolicy: "{{ exportPolicy }}"
        exportPolicyConfiguration:
          exportPolicies:
            - "{{ exportPolicies }}"
        monitoredAddressFamilies:
          - "{{ monitoredAddressFamilies }}"
      lastOperation:
        details: "{{ details }}"
      configurationState: "{{ configurationState }}"
      provisioningState: "{{ provisioningState }}"
      administrativeState: "{{ administrativeState }}"

UPDATE examples

update

API to update certain properties of the NetworkMonitor resource.

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

DELETE examples

delete

Deletes layer 2 connectivity between compute nodes by managed by named NetworkMonitor name.

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

Lifecycle Methods

update_administrative_state

Enables isolation domain across the fabric or on specified racks.

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