Skip to content

[Network] az network watcher flow-log: Add --record-types parameter #32490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
necusjz merged 7 commits into from
Dec 8, 2025
Merged

[Network] az network watcher flow-log: Add --record-types parameter #32490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a32280e
recordtype cli changes in 2025-03-01
Dec 2, 2025
8f2b7a1
added UT
Dec 2, 2025
0b36f18
Update src/azure-cli/azure/cli/command_modules/network/tests/latest/t…
riddhinilawar Dec 2, 2025
0d53260
Update src/azure-cli/azure/cli/command_modules/network/tests/latest/t…
riddhinilawar Dec 2, 2025
f4e8be5
Update src/azure-cli/azure/cli/command_modules/network/tests/latest/t…
riddhinilawar Dec 3, 2025
72cb064
Added more UTs
Dec 3, 2025
00712d0
update test fixed
Dec 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 35 additions & 6 deletions ...zure-cli/azure/cli/command_modules/network/aaz/latest/network/watcher/flow_log/_create.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,15 @@ class Create(AAZCommand):

:example: Create or update flow log
az network watcher flow-log create --location westus --resource-group MtRGContainingVNet --name MyVNetName-flowlog --vnet MyVNetName --storage-account MyStorageAccountName --filtering-criteria "dstip=20.252.145.59 || DstPort=443"

:example: Create flow log with recordtypes filtering
az network watcher flow-log create --resource-group rg1 --network-watcher-name nw1 --name fl --location centraluseuap --target-resource-id /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg --storage-account /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe --filtering-criteria srcIP=158.255.7.8 || dstPort=56891 --record-types B,E --enabled True --format JSON --log-version 1 --identity "{type:UserAssigned,user-assigned-identities:{/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1:{}}}"
"""

_aaz_info = {
"version": "2024-03-01",
"version": "2025-03-01",
"resources": [
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/networkwatchers/{}/flowlogs/{}", "2024-03-01"],
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/networkwatchers/{}/flowlogs/{}", "2025-03-01"],
]
}

Expand Down Expand Up @@ -130,17 +133,29 @@ def _build_arguments_schema(cls, *args, **kwargs):
)

identity = cls._args_schema.identity

identity.mi_system_assigned = AAZStrArg(
options=["system-assigned", "mi-system-assigned"],
help="Set the system managed identity.",
blank="True",
)
identity.type = AAZStrArg(
options=["type"],
help="The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.",
enum={"None": "None", "SystemAssigned": "SystemAssigned", "SystemAssigned, UserAssigned": "SystemAssigned, UserAssigned", "UserAssigned": "UserAssigned"},
)
identity.mi_user_assigned = AAZListArg(
options=["user-assigned", "mi-user-assigned"],
help="Set the user managed identities.",
blank=[],
)
identity.user_assigned_identities = AAZDictArg(
options=["user-assigned-identities"],
help="The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
)

mi_user_assigned = cls._args_schema.identity.mi_user_assigned
mi_user_assigned.Element = AAZStrArg()

user_assigned_identities = cls._args_schema.identity.user_assigned_identities
user_assigned_identities.Element = AAZObjectArg(
blank={},
Expand All @@ -159,6 +174,11 @@ def _build_arguments_schema(cls, *args, **kwargs):
arg_group="Properties",
help="Parameters that define the configuration of traffic analytics.",
)
_args_schema.record_types = AAZStrArg(
options=["--record-types"],
arg_group="Properties",
help="Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged.",
)
_args_schema.retention_policy = AAZObjectArg(
options=["--retention-policy"],
arg_group="Properties",
Expand Down Expand Up @@ -290,7 +310,7 @@ def url_parameters(self):
def query_parameters(self):
parameters = {
**self.serialize_query_param(
"api-version", "2024-03-01",
"api-version", "2025-03-01",
required=True,
),
}
Expand All @@ -315,7 +335,7 @@ def content(self):
typ=AAZObjectType,
typ_kwargs={"flags": {"required": True, "client_flatten": True}}
)
_builder.set_prop("identity", AAZObjectType, ".identity")
_builder.set_prop("identity", AAZIdentityObjectType, ".identity")
_builder.set_prop("location", AAZStrType, ".location")
_builder.set_prop("properties", AAZObjectType, typ_kwargs={"flags": {"client_flatten": True}})
_builder.set_prop("tags", AAZDictType, ".tags")
Expand All @@ -324,18 +344,24 @@ def content(self):
if identity is not None:
identity.set_prop("type", AAZStrType, ".type")
identity.set_prop("userAssignedIdentities", AAZDictType, ".user_assigned_identities")
identity.set_prop("userAssigned", AAZListType, ".mi_user_assigned", typ_kwargs={"flags": {"action": "create"}})
identity.set_prop("systemAssigned", AAZStrType, ".mi_system_assigned", typ_kwargs={"flags": {"action": "create"}})

user_assigned_identities = _builder.get(".identity.userAssignedIdentities")
if user_assigned_identities is not None:
user_assigned_identities.set_elements(AAZObjectType, ".")

user_assigned = _builder.get(".identity.userAssigned")
if user_assigned is not None:
user_assigned.set_elements(AAZStrType, ".")

properties = _builder.get(".properties")
if properties is not None:
properties.set_prop("enabled", AAZBoolType, ".enabled")
properties.set_prop("enabledFilteringCriteria", AAZStrType, ".filtering_criteria")
properties.set_prop("flowAnalyticsConfiguration", AAZObjectType, ".flow_analytics_configuration")
properties.set_prop("format", AAZObjectType)
properties.set_prop("recordTypes", AAZStrType, ".record_types")
properties.set_prop("retentionPolicy", AAZObjectType, ".retention_policy")
properties.set_prop("storageId", AAZStrType, ".storage_account", typ_kwargs={"flags": {"required": True}})
properties.set_prop("targetResourceId", AAZStrType, ".target_resource_id", typ_kwargs={"flags": {"required": True}})
Expand Down Expand Up @@ -390,7 +416,7 @@ def _build_schema_on_200_201(cls):
flags={"read_only": True},
)
_schema_on_200_201.id = AAZStrType()
_schema_on_200_201.identity = AAZObjectType()
_schema_on_200_201.identity = AAZIdentityObjectType()
_schema_on_200_201.location = AAZStrType()
_schema_on_200_201.name = AAZStrType(
flags={"read_only": True},
Expand Down Expand Up @@ -443,6 +469,9 @@ def _build_schema_on_200_201(cls):
serialized_name="provisioningState",
flags={"read_only": True},
)
properties.record_types = AAZStrType(
serialized_name="recordTypes",
)
properties.retention_policy = AAZObjectType(
serialized_name="retentionPolicy",
)
Expand Down
6 changes: 3 additions & 3 deletions ...zure-cli/azure/cli/command_modules/network/aaz/latest/network/watcher/flow_log/_delete.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ class Delete(AAZCommand):
"""

_aaz_info = {
"version": "2024-03-01",
"version": "2025-03-01",
"resources": [
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/networkwatchers/{}/flowlogs/{}", "2024-03-01"],
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/networkwatchers/{}/flowlogs/{}", "2025-03-01"],
]
}

Expand Down Expand Up @@ -152,7 +152,7 @@ def url_parameters(self):
def query_parameters(self):
parameters = {
**self.serialize_query_param(
"api-version", "2024-03-01",
"api-version", "2025-03-01",
required=True,
),
}
Expand Down
37 changes: 34 additions & 3 deletions src/azure-cli/azure/cli/command_modules/network/aaz/latest/network/watcher/flow_log/_show.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ class Show(AAZCommand):
"""

_aaz_info = {
"version": "2024-03-01",
"version": "2025-03-01",
"resources": [
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/networkwatchers/{}/flowlogs/{}", "2024-03-01"],
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/networkwatchers/{}/flowlogs/{}", "2025-03-01"],
]
}

Expand Down Expand Up @@ -133,7 +133,7 @@ def url_parameters(self):
def query_parameters(self):
parameters = {
**self.serialize_query_param(
"api-version", "2024-03-01",
"api-version", "2025-03-01",
required=True,
),
}
Expand Down Expand Up @@ -170,6 +170,7 @@ def _build_schema_on_200(cls):
flags={"read_only": True},
)
_schema_on_200.id = AAZStrType()
_schema_on_200.identity = AAZIdentityObjectType()
_schema_on_200.location = AAZStrType()
_schema_on_200.name = AAZStrType(
flags={"read_only": True},
Expand All @@ -182,6 +183,33 @@ def _build_schema_on_200(cls):
flags={"read_only": True},
)

identity = cls._schema_on_200.identity
identity.principal_id = AAZStrType(
serialized_name="principalId",
flags={"read_only": True},
)
identity.tenant_id = AAZStrType(
serialized_name="tenantId",
flags={"read_only": True},
)
identity.type = AAZStrType()
identity.user_assigned_identities = AAZDictType(
serialized_name="userAssignedIdentities",
)

user_assigned_identities = cls._schema_on_200.identity.user_assigned_identities
user_assigned_identities.Element = AAZObjectType()

_element = cls._schema_on_200.identity.user_assigned_identities.Element
_element.client_id = AAZStrType(
serialized_name="clientId",
flags={"read_only": True},
)
_element.principal_id = AAZStrType(
serialized_name="principalId",
flags={"read_only": True},
)

properties = cls._schema_on_200.properties
properties.enabled = AAZBoolType()
properties.enabled_filtering_criteria = AAZStrType(
Expand All @@ -195,6 +223,9 @@ def _build_schema_on_200(cls):
serialized_name="provisioningState",
flags={"read_only": True},
)
properties.record_types = AAZStrType(
serialized_name="recordTypes",
)
properties.retention_policy = AAZObjectType(
serialized_name="retentionPolicy",
)
Expand Down
21 changes: 17 additions & 4 deletions ...zure-cli/azure/cli/command_modules/network/aaz/latest/network/watcher/flow_log/_update.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,15 @@ class Update(AAZCommand):

:example: Update Workspace on another resource group
az network watcher flow-log update --location westus --resource-group MyAnotherResourceGroup --name MyFlowLog --workspace MyAnotherLogAnalyticWorkspace

:example: Update flowlog with recordtypes filtering
az network watcher flow-log update --resource-group rg1 --network-watcher-name nw1 --name fl --location centraluseuap --target-resource-id /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg --storage-account /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe --filtering-criteria srcIP=158.255.7.8 || dstPort=56891 --record-types B,E --enabled True --format JSON --log-version 1 --identity "{type:UserAssigned,user-assigned-identities:{/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1:{}}}"
"""

_aaz_info = {
"version": "2024-03-01",
"version": "2025-03-01",
"resources": [
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/networkwatchers/{}/flowlogs/{}", "2024-03-01"],
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/networkwatchers/{}/flowlogs/{}", "2025-03-01"],
]
}

Expand Down Expand Up @@ -165,6 +168,12 @@ def _build_arguments_schema(cls, *args, **kwargs):
help="Parameters that define the configuration of traffic analytics.",
nullable=True,
)
_args_schema.record_types = AAZStrArg(
options=["--record-types"],
arg_group="Properties",
help="Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged.",
nullable=True,
)
_args_schema.retention_policy = AAZObjectArg(
options=["--retention-policy"],
arg_group="Properties",
Expand Down Expand Up @@ -299,7 +308,7 @@ def url_parameters(self):
def query_parameters(self):
parameters = {
**self.serialize_query_param(
"api-version", "2024-03-01",
"api-version", "2025-03-01",
required=True,
),
}
Expand Down Expand Up @@ -402,7 +411,7 @@ def url_parameters(self):
def query_parameters(self):
parameters = {
**self.serialize_query_param(
"api-version", "2024-03-01",
"api-version", "2025-03-01",
required=True,
),
}
Expand Down Expand Up @@ -480,6 +489,7 @@ def _update_instance(self, instance):
properties.set_prop("enabledFilteringCriteria", AAZStrType, ".filtering_criteria")
properties.set_prop("flowAnalyticsConfiguration", AAZObjectType, ".flow_analytics_configuration")
properties.set_prop("format", AAZObjectType)
properties.set_prop("recordTypes", AAZStrType, ".record_types")
properties.set_prop("retentionPolicy", AAZObjectType, ".retention_policy")
properties.set_prop("storageId", AAZStrType, ".storage_account", typ_kwargs={"flags": {"required": True}})
properties.set_prop("targetResourceId", AAZStrType, ".target_resource_id", typ_kwargs={"flags": {"required": True}})
Expand Down Expand Up @@ -599,6 +609,9 @@ def _build_schema_flow_log_read(cls, _schema):
serialized_name="provisioningState",
flags={"read_only": True},
)
properties.record_types = AAZStrType(
serialized_name="recordTypes",
)
properties.retention_policy = AAZObjectType(
serialized_name="retentionPolicy",
)
Expand Down
35 changes: 33 additions & 2 deletions src/azure-cli/azure/cli/command_modules/network/aaz/latest/network/watcher/flow_log/_wait.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class Wait(AAZWaitCommand):

_aaz_info = {
"resources": [
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/networkwatchers/{}/flowlogs/{}", "2024-03-01"],
["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/networkwatchers/{}/flowlogs/{}", "2025-03-01"],
]
}

Expand Down Expand Up @@ -126,7 +126,7 @@ def url_parameters(self):
def query_parameters(self):
parameters = {
**self.serialize_query_param(
"api-version", "2024-03-01",
"api-version", "2025-03-01",
required=True,
),
}
Expand Down Expand Up @@ -163,6 +163,7 @@ def _build_schema_on_200(cls):
flags={"read_only": True},
)
_schema_on_200.id = AAZStrType()
_schema_on_200.identity = AAZIdentityObjectType()
_schema_on_200.location = AAZStrType()
_schema_on_200.name = AAZStrType(
flags={"read_only": True},
Expand All @@ -175,6 +176,33 @@ def _build_schema_on_200(cls):
flags={"read_only": True},
)

identity = cls._schema_on_200.identity
identity.principal_id = AAZStrType(
serialized_name="principalId",
flags={"read_only": True},
)
identity.tenant_id = AAZStrType(
serialized_name="tenantId",
flags={"read_only": True},
)
identity.type = AAZStrType()
identity.user_assigned_identities = AAZDictType(
serialized_name="userAssignedIdentities",
)

user_assigned_identities = cls._schema_on_200.identity.user_assigned_identities
user_assigned_identities.Element = AAZObjectType()

_element = cls._schema_on_200.identity.user_assigned_identities.Element
_element.client_id = AAZStrType(
serialized_name="clientId",
flags={"read_only": True},
)
_element.principal_id = AAZStrType(
serialized_name="principalId",
flags={"read_only": True},
)

properties = cls._schema_on_200.properties
properties.enabled = AAZBoolType()
properties.enabled_filtering_criteria = AAZStrType(
Expand All @@ -188,6 +216,9 @@ def _build_schema_on_200(cls):
serialized_name="provisioningState",
flags={"read_only": True},
)
properties.record_types = AAZStrType(
serialized_name="recordTypes",
)
properties.retention_policy = AAZObjectType(
serialized_name="retentionPolicy",
)
Expand Down
Loading