network.azure.com/v1api20241001
APIVersion
| Value | Description |
|---|---|
| “2024-10-01” |
NetworkWatcher
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-10-01/networkWatcher.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}
Used by: NetworkWatcherList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NetworkWatcher_Spec Optional |
|
| status | NetworkWatcher_STATUS Optional |
NetworkWatcher_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | Resource location. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NetworkWatcherOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| tags | Resource tags. | map[string]string Optional |
NetworkWatcher_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| etag | A unique read-only string that changes whenever the resource is updated. | string Optional |
| id | Resource ID. | string Optional |
| location | Resource location. | string Optional |
| name | Resource name. | string Optional |
| provisioningState | The provisioning state of the network watcher resource. | NetworkWatcherProvisioningState_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | Resource type. | string Optional |
NetworkWatcherList
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-10-01/networkWatcher.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NetworkWatcher[] Optional |
NetworkWatchersFlowLog
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-10-01/networkWatcher.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}
Used by: NetworkWatchersFlowLogList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NetworkWatchersFlowLog_Spec Optional |
|
| status | NetworkWatchersFlowLog_STATUS Optional |
NetworkWatchersFlowLog_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| enabled | Flag to enable/disable flow logging. | bool Optional |
| enabledFilteringCriteria | Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action. If not specified, all network traffic will be logged. | string Optional |
| flowAnalyticsConfiguration | Parameters that define the configuration of traffic analytics. | TrafficAnalyticsProperties Optional |
| format | Parameters that define the flow log format. | FlowLogFormatParameters Optional |
| identity | FlowLog resource Managed Identity | ManagedServiceIdentity Optional |
| location | Resource location. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NetworkWatchersFlowLogOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/NetworkWatcher resource | genruntime.KnownResourceReference Required |
| retentionPolicy | Parameters that define the retention policy for flow log. | RetentionPolicyParameters Optional |
| storageReference | ID of the storage account which is used to store the flow log. | genruntime.ResourceReference Required |
| tags | Resource tags. | map[string]string Optional |
| targetResourceReference | ID of network security group to which flow log will be applied. | genruntime.ResourceReference Required |
NetworkWatchersFlowLog_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| enabled | Flag to enable/disable flow logging. | bool Optional |
| enabledFilteringCriteria | Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action. If not specified, all network traffic will be logged. | string Optional |
| etag | A unique read-only string that changes whenever the resource is updated. | string Optional |
| flowAnalyticsConfiguration | Parameters that define the configuration of traffic analytics. | TrafficAnalyticsProperties_STATUS Optional |
| format | Parameters that define the flow log format. | FlowLogFormatParameters_STATUS Optional |
| id | Resource ID. | string Optional |
| identity | FlowLog resource Managed Identity | ManagedServiceIdentity_STATUS Optional |
| location | Resource location. | string Optional |
| name | Resource name. | string Optional |
| provisioningState | The provisioning state of the flow log. | ApplicationGatewayProvisioningState_STATUS Optional |
| retentionPolicy | Parameters that define the retention policy for flow log. | RetentionPolicyParameters_STATUS Optional |
| storageId | ID of the storage account which is used to store the flow log. | string Optional |
| tags | Resource tags. | map[string]string Optional |
| targetResourceGuid | Guid of network security group to which flow log will be applied. | string Optional |
| targetResourceId | ID of network security group to which flow log will be applied. | string Optional |
| type | Resource type. | string Optional |
NetworkWatchersFlowLogList
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-10-01/networkWatcher.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NetworkWatchersFlowLog[] Optional |
NetworkWatcher_Spec
Used by: NetworkWatcher.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | Resource location. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NetworkWatcherOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| tags | Resource tags. | map[string]string Optional |
NetworkWatcher_STATUS
Network watcher in a resource group.
Used by: NetworkWatcher.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| etag | A unique read-only string that changes whenever the resource is updated. | string Optional |
| id | Resource ID. | string Optional |
| location | Resource location. | string Optional |
| name | Resource name. | string Optional |
| provisioningState | The provisioning state of the network watcher resource. | NetworkWatcherProvisioningState_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | Resource type. | string Optional |
NetworkWatchersFlowLog_Spec
Used by: NetworkWatchersFlowLog.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| enabled | Flag to enable/disable flow logging. | bool Optional |
| enabledFilteringCriteria | Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action. If not specified, all network traffic will be logged. | string Optional |
| flowAnalyticsConfiguration | Parameters that define the configuration of traffic analytics. | TrafficAnalyticsProperties Optional |
| format | Parameters that define the flow log format. | FlowLogFormatParameters Optional |
| identity | FlowLog resource Managed Identity | ManagedServiceIdentity Optional |
| location | Resource location. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NetworkWatchersFlowLogOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/NetworkWatcher resource | genruntime.KnownResourceReference Required |
| retentionPolicy | Parameters that define the retention policy for flow log. | RetentionPolicyParameters Optional |
| storageReference | ID of the storage account which is used to store the flow log. | genruntime.ResourceReference Required |
| tags | Resource tags. | map[string]string Optional |
| targetResourceReference | ID of network security group to which flow log will be applied. | genruntime.ResourceReference Required |
NetworkWatchersFlowLog_STATUS
Used by: NetworkWatchersFlowLog.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| enabled | Flag to enable/disable flow logging. | bool Optional |
| enabledFilteringCriteria | Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action. If not specified, all network traffic will be logged. | string Optional |
| etag | A unique read-only string that changes whenever the resource is updated. | string Optional |
| flowAnalyticsConfiguration | Parameters that define the configuration of traffic analytics. | TrafficAnalyticsProperties_STATUS Optional |
| format | Parameters that define the flow log format. | FlowLogFormatParameters_STATUS Optional |
| id | Resource ID. | string Optional |
| identity | FlowLog resource Managed Identity | ManagedServiceIdentity_STATUS Optional |
| location | Resource location. | string Optional |
| name | Resource name. | string Optional |
| provisioningState | The provisioning state of the flow log. | ApplicationGatewayProvisioningState_STATUS Optional |
| retentionPolicy | Parameters that define the retention policy for flow log. | RetentionPolicyParameters_STATUS Optional |
| storageId | ID of the storage account which is used to store the flow log. | string Optional |
| tags | Resource tags. | map[string]string Optional |
| targetResourceGuid | Guid of network security group to which flow log will be applied. | string Optional |
| targetResourceId | ID of network security group to which flow log will be applied. | string Optional |
| type | Resource type. | string Optional |
ApplicationGatewayProvisioningState_STATUS
The current provisioning state.
Used by: NetworkWatchersFlowLog_STATUS.
| Value | Description |
|---|---|
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
FlowLogFormatParameters
Parameters that define the flow log format.
Used by: NetworkWatchersFlowLog_Spec.
| Property | Description | Type |
|---|---|---|
| type | The file type of flow log. | FlowLogFormatParameters_Type Optional |
| version | The version (revision) of the flow log. | int Optional |
FlowLogFormatParameters_STATUS
Parameters that define the flow log format.
Used by: NetworkWatchersFlowLog_STATUS.
| Property | Description | Type |
|---|---|---|
| type | The file type of flow log. | FlowLogFormatParameters_Type_STATUS Optional |
| version | The version (revision) of the flow log. | int Optional |
ManagedServiceIdentity
Identity for the resource.
Used by: NetworkWatchersFlowLog_Spec.
| Property | Description | Type |
|---|---|---|
| type | 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. |
ManagedServiceIdentity_Type Optional |
| userAssignedIdentities | 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}’. | UserAssignedIdentityDetails[] Optional |
ManagedServiceIdentity_STATUS
Identity for the resource.
Used by: NetworkWatchersFlowLog_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The principal id of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| tenantId | The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| type | 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. |
ManagedServiceIdentity_Type_STATUS Optional |
| userAssignedIdentities | 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}’. | map[string]ManagedServiceIdentity_UserAssignedIdentities_STATUS Optional |
NetworkWatcherOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NetworkWatcher_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
NetworkWatcherProvisioningState_STATUS
The current provisioning state.
Used by: NetworkWatcher_STATUS.
| Value | Description |
|---|---|
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
NetworkWatchersFlowLogOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NetworkWatchersFlowLog_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
RetentionPolicyParameters
Parameters that define the retention policy for flow log.
Used by: NetworkWatchersFlowLog_Spec.
| Property | Description | Type |
|---|---|---|
| days | Number of days to retain flow log records. | int Optional |
| enabled | Flag to enable/disable retention. | bool Optional |
RetentionPolicyParameters_STATUS
Parameters that define the retention policy for flow log.
Used by: NetworkWatchersFlowLog_STATUS.
| Property | Description | Type |
|---|---|---|
| days | Number of days to retain flow log records. | int Optional |
| enabled | Flag to enable/disable retention. | bool Optional |
TrafficAnalyticsProperties
Parameters that define the configuration of traffic analytics.
Used by: NetworkWatchersFlowLog_Spec.
| Property | Description | Type |
|---|---|---|
| networkWatcherFlowAnalyticsConfiguration | Parameters that define the configuration of traffic analytics. | TrafficAnalyticsConfigurationProperties Optional |
TrafficAnalyticsProperties_STATUS
Parameters that define the configuration of traffic analytics.
Used by: NetworkWatchersFlowLog_STATUS.
| Property | Description | Type |
|---|---|---|
| networkWatcherFlowAnalyticsConfiguration | Parameters that define the configuration of traffic analytics. | TrafficAnalyticsConfigurationProperties_STATUS Optional |
FlowLogFormatParameters_Type
Used by: FlowLogFormatParameters.
| Value | Description |
|---|---|
| “JSON” |
FlowLogFormatParameters_Type_STATUS
Used by: FlowLogFormatParameters_STATUS.
| Value | Description |
|---|---|
| “JSON” |
ManagedServiceIdentity_Type
Used by: ManagedServiceIdentity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
ManagedServiceIdentity_Type_STATUS
Used by: ManagedServiceIdentity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
ManagedServiceIdentity_UserAssignedIdentities_STATUS
Used by: ManagedServiceIdentity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client id of user assigned identity. | string Optional |
| principalId | The principal id of user assigned identity. | string Optional |
TrafficAnalyticsConfigurationProperties
Parameters that define the configuration of traffic analytics.
Used by: TrafficAnalyticsProperties.
| Property | Description | Type |
|---|---|---|
| enabled | Flag to enable/disable traffic analytics. | bool Optional |
| trafficAnalyticsInterval | The interval in minutes which would decide how frequently TA service should do flow analytics. | int Optional |
| workspaceRegion | The location of the attached workspace. | string Optional |
| workspaceResourceReference | Resource Id of the attached workspace. | genruntime.ResourceReference Optional |
TrafficAnalyticsConfigurationProperties_STATUS
Parameters that define the configuration of traffic analytics.
Used by: TrafficAnalyticsProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| enabled | Flag to enable/disable traffic analytics. | bool Optional |
| trafficAnalyticsInterval | The interval in minutes which would decide how frequently TA service should do flow analytics. | int Optional |
| workspaceId | The resource guid of the attached workspace. | string Optional |
| workspaceRegion | The location of the attached workspace. | string Optional |
| workspaceResourceId | Resource Id of the attached workspace. | string Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: ManagedServiceIdentity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |