你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Network Watchers - Set Flow Log Configuration
在指定资源上配置流日志和流量分析(可选)。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/configureFlowLog?api-version=2024-05-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
network
|
path | True |
string |
网络观察程序资源的名称。 |
resource
|
path | True |
string |
网络观察程序资源组的名称。 |
subscription
|
path | True |
string |
唯一标识 Azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
请求正文
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
properties.enabled | True |
boolean |
用于启用/禁用流日志记录的标志。 |
properties.storageId | True |
string |
用于存储流日志的存储帐户的 ID。 |
targetResourceId | True |
string |
要为流日志和流量分析(可选)配置的资源的 ID。 |
flowAnalyticsConfiguration |
定义流量分析配置的参数。 |
||
identity |
FlowLog 资源托管标识 |
||
properties.enabledFilteringCriteria |
string |
可选字段,用于根据 SrcIP、SrcPort、DstIP、DstPort、协议、加密、方向和操作筛选网络流量日志。 如果未指定,将记录所有网络流量。 |
|
properties.format |
定义流日志格式的参数。 |
||
properties.retentionPolicy |
定义流日志保留策略的参数。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
成功请求设置流日志和流量分析(可选)配置。 |
|
202 Accepted |
接受且操作将以异步方式完成。 |
|
Other Status Codes |
描述操作失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Configure flow log
示例请求
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/configureFlowLog?api-version=2024-05-01
{
"targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
"properties": {
"storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
"enabled": true
},
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
}
}
}
示例响应
{
"targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
"properties": {
"storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
"enabled": true
},
"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: https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/configureFlowLog?api-version=2024-05-01
{
"targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
"properties": {
"storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
"enabled": true
},
"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"
}
}
}
}
定义
名称 | 说明 |
---|---|
Error |
常见的错误详细信息表示形式。 |
Error |
错误对象。 |
Flow |
定义流日志格式的参数。 |
Flow |
流日志的文件类型。 |
Flow |
有关流日志和流量分析的配置信息(可选)。 |
Managed |
资源的标识。 |
Resource |
用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。 |
Retention |
定义流日志保留策略的参数。 |
Traffic |
定义流量分析配置的参数。 |
Traffic |
定义流量分析配置的参数。 |
User |
与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 |
ErrorDetails
常见的错误详细信息表示形式。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
message |
string |
错误信息。 |
target |
string |
错误目标。 |
ErrorResponse
错误对象。
名称 | 类型 | 说明 |
---|---|---|
error |
错误 |
FlowLogFormatParameters
定义流日志格式的参数。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
type |
流日志的文件类型。 |
||
version |
integer |
0 |
流日志的版本(修订版)。 |
FlowLogFormatType
流日志的文件类型。
名称 | 类型 | 说明 |
---|---|---|
JSON |
string |
FlowLogInformation
有关流日志和流量分析的配置信息(可选)。
名称 | 类型 | 说明 |
---|---|---|
flowAnalyticsConfiguration |
定义流量分析配置的参数。 |
|
identity |
FlowLog 资源托管标识 |
|
properties.enabled |
boolean |
用于启用/禁用流日志记录的标志。 |
properties.enabledFilteringCriteria |
string |
可选字段,用于根据 SrcIP、SrcPort、DstIP、DstPort、协议、加密、方向和操作筛选网络流量日志。 如果未指定,将记录所有网络流量。 |
properties.format |
定义流日志格式的参数。 |
|
properties.retentionPolicy |
定义流日志保留策略的参数。 |
|
properties.storageId |
string |
用于存储流日志的存储帐户的 ID。 |
targetResourceId |
string |
要为流日志和流量分析(可选)配置的资源的 ID。 |
ManagedServiceIdentity
资源的标识。
名称 | 类型 | 说明 |
---|---|---|
principalId |
string |
系统分配标识的主体 ID。 此属性仅针对系统分配的标识提供。 |
tenantId |
string |
系统分配标识的租户 ID。 此属性仅针对系统分配的标识提供。 |
type |
用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。 |
|
userAssignedIdentities |
与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 |
ResourceIdentityType
用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RetentionPolicyParameters
定义流日志保留策略的参数。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
days |
integer |
0 |
保留流日志记录的天数。 |
enabled |
boolean |
False |
用于启用/禁用保留的标志。 |
TrafficAnalyticsConfigurationProperties
定义流量分析配置的参数。
名称 | 类型 | 说明 |
---|---|---|
enabled |
boolean |
用于启用/禁用流量分析的标志。 |
trafficAnalyticsInterval |
integer |
以分钟为单位的时间间隔,决定 TA 服务应执行流分析的频率。 |
workspaceId |
string |
附加工作区的资源 GUID。 |
workspaceRegion |
string |
附加工作区的位置。 |
workspaceResourceId |
string |
附加工作区的资源 ID。 |
TrafficAnalyticsProperties
定义流量分析配置的参数。
名称 | 类型 | 说明 |
---|---|---|
networkWatcherFlowAnalyticsConfiguration |
定义流量分析配置的参数。 |
UserAssignedIdentities
与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
名称 | 类型 | 说明 |
---|---|---|
|