共用方式為


Flow Logs - Create Or Update

為指定的網路安全組建立或更新流程記錄。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}?api-version=2024-05-01

URI 參數

名稱 位於 必要 類型 Description
flowLogName
path True

string

流程記錄檔的名稱。

networkWatcherName
path True

string

網路監看員的名稱。

resourceGroupName
path True

string

資源群組的名稱。

subscriptionId
path True

string

可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。

api-version
query True

string

用戶端 API 版本。

要求本文

名稱 必要 類型 Description
properties.storageId True

string

用來儲存流量記錄的記憶體帳戶標識碼。

properties.targetResourceId True

string

將套用流量記錄的網路安全組標識碼。

id

string

資源標識碼。

identity

ManagedServiceIdentity

FlowLog 資源受控識別

location

string

資源位置。

properties.enabled

boolean

啟用/停用流量記錄的旗標。

properties.enabledFilteringCriteria

string

選擇性欄位,可根據 SrcIP、SrcPort、DstIP、DstPort、通訊協定、加密、方向和動作來篩選網路流量記錄。 如果未指定,則會記錄所有網路流量。

properties.flowAnalyticsConfiguration

TrafficAnalyticsProperties

定義使用分析組態的參數。

properties.format

FlowLogFormatParameters

定義流程記錄格式的參數。

properties.retentionPolicy

RetentionPolicyParameters

定義流量記錄保留原則的參數。

tags

object

資源標籤。

回應

名稱 類型 Description
200 OK

FlowLog

更新成功。 作業會傳回產生的流量記錄資源。

201 Created

FlowLog

要求成功。 作業會傳回產生的流量記錄資源。

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Create or update flow log

範例要求

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/flowLogs/fl?api-version=2024-05-01

{
  "location": "centraluseuap",
  "properties": {
    "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg",
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe",
    "enabledFilteringCriteria": "srcIP=158.255.7.8 || dstPort=56891",
    "enabled": true,
    "format": {
      "type": "JSON",
      "version": 1
    }
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  }
}

範例回覆

{
  "name": "Microsoft.Networkdesmond-rgdesmondcentral-nsg",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw/FlowLogs/fl",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "properties": {
    "provisioningState": "Updating",
    "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg",
    "targetResourceGuid": "00000000-0000-0000-0000-000000000000",
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe",
    "enabledFilteringCriteria": "srcIP=158.255.7.8 || dstPort=56891",
    "enabled": true,
    "flowAnalyticsConfiguration": {},
    "retentionPolicy": {
      "days": 0,
      "enabled": false
    },
    "format": {
      "type": "JSON",
      "version": 1
    }
  },
  "type": "Microsoft.Network/networkWatchers/FlowLogs",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14",
        "principalId": "e3858881-e40c-43bd-9cde-88da39c05023"
      }
    }
  },
  "location": "centraluseuap"
}
{
  "name": "Microsoft.Networkdesmond-rgdesmondcentral-nsg",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw/FlowLogs/fl",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "properties": {
    "provisioningState": "Succeeded",
    "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg",
    "targetResourceGuid": "00000000-0000-0000-0000-000000000000",
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe",
    "enabledFilteringCriteria": "srcIP=158.255.7.8 || dstPort=56891",
    "enabled": true,
    "flowAnalyticsConfiguration": {},
    "retentionPolicy": {
      "days": 0,
      "enabled": false
    },
    "format": {
      "type": "JSON",
      "version": 1
    }
  },
  "type": "Microsoft.Network/networkWatchers/FlowLogs",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14",
        "principalId": "e3858881-e40c-43bd-9cde-88da39c05023"
      }
    }
  },
  "location": "centraluseuap"
}

定義

名稱 Description
ErrorDetails

常見的錯誤詳細數據表示。

ErrorResponse

error 物件。

FlowLog

流量記錄資源。

FlowLogFormatParameters

定義流程記錄格式的參數。

FlowLogFormatType

流量記錄檔的文件類型。

ManagedServiceIdentity

資源的身分識別。

ProvisioningState

目前的布建狀態。

ResourceIdentityType

用於資源的身分識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從虛擬機中移除任何身分識別。

RetentionPolicyParameters

定義流量記錄保留原則的參數。

TrafficAnalyticsConfigurationProperties

定義使用分析組態的參數。

TrafficAnalyticsProperties

定義使用分析組態的參數。

UserAssignedIdentities

與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

ErrorDetails

常見的錯誤詳細數據表示。

名稱 類型 Description
code

string

錯誤碼。

message

string

錯誤資訊。

target

string

錯誤目標。

ErrorResponse

error 物件。

名稱 類型 Description
error

ErrorDetails

錯誤
錯誤詳細資料物件。

FlowLog

流量記錄資源。

名稱 類型 Description
etag

string

每當更新資源時變更的唯一隻讀字串。

id

string

資源標識碼。

identity

ManagedServiceIdentity

FlowLog 資源受控識別

location

string

資源位置。

name

string

資源名稱。

properties.enabled

boolean

啟用/停用流量記錄的旗標。

properties.enabledFilteringCriteria

string

選擇性欄位,可根據 SrcIP、SrcPort、DstIP、DstPort、通訊協定、加密、方向和動作來篩選網路流量記錄。 如果未指定,則會記錄所有網路流量。

properties.flowAnalyticsConfiguration

TrafficAnalyticsProperties

定義使用分析組態的參數。

properties.format

FlowLogFormatParameters

定義流程記錄格式的參數。

properties.provisioningState

ProvisioningState

流量記錄的布建狀態。

properties.retentionPolicy

RetentionPolicyParameters

定義流量記錄保留原則的參數。

properties.storageId

string

用來儲存流量記錄的記憶體帳戶標識碼。

properties.targetResourceGuid

string

將套用流量記錄的網路安全組 GUID。

properties.targetResourceId

string

將套用流量記錄的網路安全組標識碼。

tags

object

資源標籤。

type

string

資源類型。

FlowLogFormatParameters

定義流程記錄格式的參數。

名稱 類型 預設值 Description
type

FlowLogFormatType

流量記錄檔的文件類型。

version

integer

0

流程記錄的版本(修訂)。

FlowLogFormatType

流量記錄檔的文件類型。

名稱 類型 Description
JSON

string

ManagedServiceIdentity

資源的身分識別。

名稱 類型 Description
principalId

string

系統指派身分識別的主體標識碼。 此屬性只會針對系統指派的身分識別提供。

tenantId

string

系統指派身分識別的租用戶標識碼。 此屬性只會針對系統指派的身分識別提供。

type

ResourceIdentityType

用於資源的身分識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從虛擬機中移除任何身分識別。

userAssignedIdentities

UserAssignedIdentities

與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

ProvisioningState

目前的布建狀態。

名稱 類型 Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

ResourceIdentityType

用於資源的身分識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從虛擬機中移除任何身分識別。

名稱 類型 Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RetentionPolicyParameters

定義流量記錄保留原則的參數。

名稱 類型 預設值 Description
days

integer

0

保留流量記錄檔記錄的天數。

enabled

boolean

False

啟用/停用保留的旗標。

TrafficAnalyticsConfigurationProperties

定義使用分析組態的參數。

名稱 類型 Description
enabled

boolean

啟用/停用使用分析的旗標。

trafficAnalyticsInterval

integer

以分鐘為單位的間隔,決定TA服務應該執行流程分析的頻率。

workspaceId

string

附加工作區的資源 GUID。

workspaceRegion

string

附加工作區的位置。

workspaceResourceId

string

附加工作區的資源標識碼。

TrafficAnalyticsProperties

定義使用分析組態的參數。

名稱 類型 Description
networkWatcherFlowAnalyticsConfiguration

TrafficAnalyticsConfigurationProperties

定義使用分析組態的參數。

UserAssignedIdentities

與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

名稱 類型 Description