你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.Network networkWatchers/connectionMonitors 2020-06-01
Bicep 资源定义
可以使用目标操作部署 networkWatchers/connectionMonitors 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.Network/networkWatchers/connectionMonitors 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Network/networkWatchers/connectionMonitors@2020-06-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
autoStart: bool
destination: {
address: 'string'
port: int
resourceId: 'string'
}
endpoints: [
{
address: 'string'
coverageLevel: 'string'
filter: {
items: [
{
address: 'string'
type: 'string'
}
]
type: 'string'
}
name: 'string'
resourceId: 'string'
scope: {
exclude: [
{
address: 'string'
}
]
include: [
{
address: 'string'
}
]
}
type: 'string'
}
]
monitoringIntervalInSeconds: int
notes: 'string'
outputs: [
{
type: 'string'
workspaceSettings: {
workspaceResourceId: 'string'
}
}
]
source: {
port: int
resourceId: 'string'
}
testConfigurations: [
{
httpConfiguration: {
method: 'string'
path: 'string'
port: int
preferHTTPS: bool
requestHeaders: [
{
name: 'string'
value: 'string'
}
]
validStatusCodeRanges: [
'string'
]
}
icmpConfiguration: {
disableTraceRoute: bool
}
name: 'string'
preferredIPVersion: 'string'
protocol: 'string'
successThreshold: {
checksFailedPercent: int
roundTripTimeMs: int
}
tcpConfiguration: {
destinationPortBehavior: 'string'
disableTraceRoute: bool
port: int
}
testFrequencySec: int
}
]
testGroups: [
{
destinations: [
'string'
]
disable: bool
name: 'string'
sources: [
'string'
]
testConfigurations: [
'string'
]
}
]
}
tags: {
{customized property}: 'string'
}
}
属性值
ConnectionMonitorDestination
名字 |
描述 |
价值 |
地址 |
连接监视器目标(IP 或域名)的地址。 |
字符串 |
港口 |
连接监视器使用的目标端口。 |
int |
resourceId |
连接监视器用作目标的资源的 ID。 |
字符串 |
ConnectionMonitorEndpoint
名字 |
描述 |
价值 |
地址 |
连接监视器终结点(IP 或域名)的地址。 |
字符串 |
coverageLevel |
终结点的测试覆盖率。 |
“AboveAverage” “Average” “BelowAverage” “Default” “Full” “Low” |
滤波器 |
筛选终结点中的子项。 |
ConnectionMonitorEndpointFilter |
名字 |
连接监视器终结点的名称。 |
string (必需) |
resourceId |
连接监视器终结点的资源 ID。 |
字符串 |
范围 |
终结点范围。 |
ConnectionMonitorEndpointScope |
类型 |
终结点类型。 |
“AzureSubnet” “AzureVM” “AzureVNet” “ExternalAddress” “MMAWorkspaceMachine” “MMAWorkspaceNetwork” |
ConnectionMonitorEndpointFilter
ConnectionMonitorEndpointFilterItem
名字 |
描述 |
价值 |
地址 |
筛选器项的地址。 |
字符串 |
类型 |
筛选器中包含的项的类型。 目前仅支持“AgentAddress”。 |
“AgentAddress” |
ConnectionMonitorEndpointScope
ConnectionMonitorEndpointScopeItem
名字 |
描述 |
价值 |
地址 |
终结点项的地址。 支持的类型为 IPv4/IPv6 子网掩码或 IPv4/IPv6 IP 地址。 |
字符串 |
ConnectionMonitorHttpConfiguration
名字 |
描述 |
价值 |
方法 |
要使用的 HTTP 方法。 |
“Get” “Post” |
路径 |
URI 的路径组件。 例如,“/dir1/dir2”。 |
字符串 |
港口 |
要连接到的端口。 |
int |
preferHTTPS |
指示在选择不显式的情况下,HTTPS 是否优先于 HTTP 的值。 |
bool |
requestHeaders |
要随请求一起传输的 HTTP 标头。 |
HttpHeader[] |
validStatusCodeRanges |
要考虑成功的 HTTP 状态代码。 例如,“2xx,301-304,418”。 |
string[] |
ConnectionMonitorIcmpConfiguration
名字 |
描述 |
价值 |
disableTraceRoute |
指示是否应禁用包含跟踪路由的路径评估的值。 |
bool |
ConnectionMonitorOutput
ConnectionMonitorParametersOrConnectionMonitorResultProperties
ConnectionMonitorSource
名字 |
描述 |
价值 |
港口 |
连接监视器使用的源端口。 |
int |
resourceId |
连接监视器用作源的资源的 ID。 |
string (必需) |
ConnectionMonitorSuccessThreshold
名字 |
描述 |
价值 |
checksFailedPercent |
允许测试评估为成功的失败检查的最大百分比。 |
int |
roundTripTimeMs |
允许测试评估为成功的往返时间(以毫秒为单位)。 |
int |
ConnectionMonitorTcpConfiguration
名字 |
描述 |
价值 |
destinationPortBehavior |
目标端口行为。 |
“ListenIfAvailable” “None” |
disableTraceRoute |
指示是否应禁用包含跟踪路由的路径评估的值。 |
bool |
港口 |
要连接到的端口。 |
int |
ConnectionMonitorTestConfiguration
ConnectionMonitorTestGroup
名字 |
描述 |
价值 |
目的地 |
目标终结点名称的列表。 |
string[] (必需) |
禁用 |
指示是否禁用测试组的值。 |
bool |
名字 |
连接监视器测试组的名称。 |
string (必需) |
来源 |
源终结点名称的列表。 |
string[] (必需) |
testConfigurations |
测试配置名称列表。 |
string[] (必需) |
ConnectionMonitorWorkspaceSettings
名字 |
描述 |
价值 |
workspaceResourceId |
Log Analytics 工作区资源 ID。 |
字符串 |
名字 |
描述 |
价值 |
名字 |
HTTP 标头中的名称。 |
字符串 |
价值 |
HTTP 标头中的值。 |
字符串 |
Microsoft.Network/networkWatchers/connectionMonitors
ARM 模板资源定义
可以使用目标操作部署 networkWatchers/connectionMonitors 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.Network/networkWatchers/connectionMonitors 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Network/networkWatchers/connectionMonitors",
"apiVersion": "2020-06-01",
"name": "string",
"location": "string",
"properties": {
"autoStart": "bool",
"destination": {
"address": "string",
"port": "int",
"resourceId": "string"
},
"endpoints": [
{
"address": "string",
"coverageLevel": "string",
"filter": {
"items": [
{
"address": "string",
"type": "string"
}
],
"type": "string"
},
"name": "string",
"resourceId": "string",
"scope": {
"exclude": [
{
"address": "string"
}
],
"include": [
{
"address": "string"
}
]
},
"type": "string"
}
],
"monitoringIntervalInSeconds": "int",
"notes": "string",
"outputs": [
{
"type": "string",
"workspaceSettings": {
"workspaceResourceId": "string"
}
}
],
"source": {
"port": "int",
"resourceId": "string"
},
"testConfigurations": [
{
"httpConfiguration": {
"method": "string",
"path": "string",
"port": "int",
"preferHTTPS": "bool",
"requestHeaders": [
{
"name": "string",
"value": "string"
}
],
"validStatusCodeRanges": [ "string" ]
},
"icmpConfiguration": {
"disableTraceRoute": "bool"
},
"name": "string",
"preferredIPVersion": "string",
"protocol": "string",
"successThreshold": {
"checksFailedPercent": "int",
"roundTripTimeMs": "int"
},
"tcpConfiguration": {
"destinationPortBehavior": "string",
"disableTraceRoute": "bool",
"port": "int"
},
"testFrequencySec": "int"
}
],
"testGroups": [
{
"destinations": [ "string" ],
"disable": "bool",
"name": "string",
"sources": [ "string" ],
"testConfigurations": [ "string" ]
}
]
},
"tags": {
"{customized property}": "string"
}
}
属性值
ConnectionMonitorDestination
名字 |
描述 |
价值 |
地址 |
连接监视器目标(IP 或域名)的地址。 |
字符串 |
港口 |
连接监视器使用的目标端口。 |
int |
resourceId |
连接监视器用作目标的资源的 ID。 |
字符串 |
ConnectionMonitorEndpoint
名字 |
描述 |
价值 |
地址 |
连接监视器终结点(IP 或域名)的地址。 |
字符串 |
coverageLevel |
终结点的测试覆盖率。 |
“AboveAverage” “Average” “BelowAverage” “Default” “Full” “Low” |
滤波器 |
筛选终结点中的子项。 |
ConnectionMonitorEndpointFilter |
名字 |
连接监视器终结点的名称。 |
string (必需) |
resourceId |
连接监视器终结点的资源 ID。 |
字符串 |
范围 |
终结点范围。 |
ConnectionMonitorEndpointScope |
类型 |
终结点类型。 |
“AzureSubnet” “AzureVM” “AzureVNet” “ExternalAddress” “MMAWorkspaceMachine” “MMAWorkspaceNetwork” |
ConnectionMonitorEndpointFilter
ConnectionMonitorEndpointFilterItem
名字 |
描述 |
价值 |
地址 |
筛选器项的地址。 |
字符串 |
类型 |
筛选器中包含的项的类型。 目前仅支持“AgentAddress”。 |
“AgentAddress” |
ConnectionMonitorEndpointScope
ConnectionMonitorEndpointScopeItem
名字 |
描述 |
价值 |
地址 |
终结点项的地址。 支持的类型为 IPv4/IPv6 子网掩码或 IPv4/IPv6 IP 地址。 |
字符串 |
ConnectionMonitorHttpConfiguration
名字 |
描述 |
价值 |
方法 |
要使用的 HTTP 方法。 |
“Get” “Post” |
路径 |
URI 的路径组件。 例如,“/dir1/dir2”。 |
字符串 |
港口 |
要连接到的端口。 |
int |
preferHTTPS |
指示在选择不显式的情况下,HTTPS 是否优先于 HTTP 的值。 |
bool |
requestHeaders |
要随请求一起传输的 HTTP 标头。 |
HttpHeader[] |
validStatusCodeRanges |
要考虑成功的 HTTP 状态代码。 例如,“2xx,301-304,418”。 |
string[] |
ConnectionMonitorIcmpConfiguration
名字 |
描述 |
价值 |
disableTraceRoute |
指示是否应禁用包含跟踪路由的路径评估的值。 |
bool |
ConnectionMonitorOutput
ConnectionMonitorParametersOrConnectionMonitorResultProperties
ConnectionMonitorSource
名字 |
描述 |
价值 |
港口 |
连接监视器使用的源端口。 |
int |
resourceId |
连接监视器用作源的资源的 ID。 |
string (必需) |
ConnectionMonitorSuccessThreshold
名字 |
描述 |
价值 |
checksFailedPercent |
允许测试评估为成功的失败检查的最大百分比。 |
int |
roundTripTimeMs |
允许测试评估为成功的往返时间(以毫秒为单位)。 |
int |
ConnectionMonitorTcpConfiguration
名字 |
描述 |
价值 |
destinationPortBehavior |
目标端口行为。 |
“ListenIfAvailable” “None” |
disableTraceRoute |
指示是否应禁用包含跟踪路由的路径评估的值。 |
bool |
港口 |
要连接到的端口。 |
int |
ConnectionMonitorTestConfiguration
ConnectionMonitorTestGroup
名字 |
描述 |
价值 |
目的地 |
目标终结点名称的列表。 |
string[] (必需) |
禁用 |
指示是否禁用测试组的值。 |
bool |
名字 |
连接监视器测试组的名称。 |
string (必需) |
来源 |
源终结点名称的列表。 |
string[] (必需) |
testConfigurations |
测试配置名称列表。 |
string[] (必需) |
ConnectionMonitorWorkspaceSettings
名字 |
描述 |
价值 |
workspaceResourceId |
Log Analytics 工作区资源 ID。 |
字符串 |
名字 |
描述 |
价值 |
名字 |
HTTP 标头中的名称。 |
字符串 |
价值 |
HTTP 标头中的值。 |
字符串 |
Microsoft.Network/networkWatchers/connectionMonitors
可以使用目标操作部署 networkWatchers/connectionMonitors 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.Network/networkWatchers/connectionMonitors 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkWatchers/connectionMonitors@2020-06-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
autoStart = bool
destination = {
address = "string"
port = int
resourceId = "string"
}
endpoints = [
{
address = "string"
coverageLevel = "string"
filter = {
items = [
{
address = "string"
type = "string"
}
]
type = "string"
}
name = "string"
resourceId = "string"
scope = {
exclude = [
{
address = "string"
}
]
include = [
{
address = "string"
}
]
}
type = "string"
}
]
monitoringIntervalInSeconds = int
notes = "string"
outputs = [
{
type = "string"
workspaceSettings = {
workspaceResourceId = "string"
}
}
]
source = {
port = int
resourceId = "string"
}
testConfigurations = [
{
httpConfiguration = {
method = "string"
path = "string"
port = int
preferHTTPS = bool
requestHeaders = [
{
name = "string"
value = "string"
}
]
validStatusCodeRanges = [
"string"
]
}
icmpConfiguration = {
disableTraceRoute = bool
}
name = "string"
preferredIPVersion = "string"
protocol = "string"
successThreshold = {
checksFailedPercent = int
roundTripTimeMs = int
}
tcpConfiguration = {
destinationPortBehavior = "string"
disableTraceRoute = bool
port = int
}
testFrequencySec = int
}
]
testGroups = [
{
destinations = [
"string"
]
disable = bool
name = "string"
sources = [
"string"
]
testConfigurations = [
"string"
]
}
]
}
})
}
属性值
ConnectionMonitorDestination
名字 |
描述 |
价值 |
地址 |
连接监视器目标(IP 或域名)的地址。 |
字符串 |
港口 |
连接监视器使用的目标端口。 |
int |
resourceId |
连接监视器用作目标的资源的 ID。 |
字符串 |
ConnectionMonitorEndpoint
名字 |
描述 |
价值 |
地址 |
连接监视器终结点(IP 或域名)的地址。 |
字符串 |
coverageLevel |
终结点的测试覆盖率。 |
“AboveAverage” “Average” “BelowAverage” “Default” “Full” “Low” |
滤波器 |
筛选终结点中的子项。 |
ConnectionMonitorEndpointFilter |
名字 |
连接监视器终结点的名称。 |
string (必需) |
resourceId |
连接监视器终结点的资源 ID。 |
字符串 |
范围 |
终结点范围。 |
ConnectionMonitorEndpointScope |
类型 |
终结点类型。 |
“AzureSubnet” “AzureVM” “AzureVNet” “ExternalAddress” “MMAWorkspaceMachine” “MMAWorkspaceNetwork” |
ConnectionMonitorEndpointFilter
ConnectionMonitorEndpointFilterItem
名字 |
描述 |
价值 |
地址 |
筛选器项的地址。 |
字符串 |
类型 |
筛选器中包含的项的类型。 目前仅支持“AgentAddress”。 |
“AgentAddress” |
ConnectionMonitorEndpointScope
ConnectionMonitorEndpointScopeItem
名字 |
描述 |
价值 |
地址 |
终结点项的地址。 支持的类型为 IPv4/IPv6 子网掩码或 IPv4/IPv6 IP 地址。 |
字符串 |
ConnectionMonitorHttpConfiguration
名字 |
描述 |
价值 |
方法 |
要使用的 HTTP 方法。 |
“Get” “Post” |
路径 |
URI 的路径组件。 例如,“/dir1/dir2”。 |
字符串 |
港口 |
要连接到的端口。 |
int |
preferHTTPS |
指示在选择不显式的情况下,HTTPS 是否优先于 HTTP 的值。 |
bool |
requestHeaders |
要随请求一起传输的 HTTP 标头。 |
HttpHeader[] |
validStatusCodeRanges |
要考虑成功的 HTTP 状态代码。 例如,“2xx,301-304,418”。 |
string[] |
ConnectionMonitorIcmpConfiguration
名字 |
描述 |
价值 |
disableTraceRoute |
指示是否应禁用包含跟踪路由的路径评估的值。 |
bool |
ConnectionMonitorOutput
ConnectionMonitorParametersOrConnectionMonitorResultProperties
ConnectionMonitorSource
名字 |
描述 |
价值 |
港口 |
连接监视器使用的源端口。 |
int |
resourceId |
连接监视器用作源的资源的 ID。 |
string (必需) |
ConnectionMonitorSuccessThreshold
名字 |
描述 |
价值 |
checksFailedPercent |
允许测试评估为成功的失败检查的最大百分比。 |
int |
roundTripTimeMs |
允许测试评估为成功的往返时间(以毫秒为单位)。 |
int |
ConnectionMonitorTcpConfiguration
名字 |
描述 |
价值 |
destinationPortBehavior |
目标端口行为。 |
“ListenIfAvailable” “None” |
disableTraceRoute |
指示是否应禁用包含跟踪路由的路径评估的值。 |
bool |
港口 |
要连接到的端口。 |
int |
ConnectionMonitorTestConfiguration
ConnectionMonitorTestGroup
名字 |
描述 |
价值 |
目的地 |
目标终结点名称的列表。 |
string[] (必需) |
禁用 |
指示是否禁用测试组的值。 |
bool |
名字 |
连接监视器测试组的名称。 |
string (必需) |
来源 |
源终结点名称的列表。 |
string[] (必需) |
testConfigurations |
测试配置名称列表。 |
string[] (必需) |
ConnectionMonitorWorkspaceSettings
名字 |
描述 |
价值 |
workspaceResourceId |
Log Analytics 工作区资源 ID。 |
字符串 |
名字 |
描述 |
价值 |
名字 |
HTTP 标头中的名称。 |
字符串 |
价值 |
HTTP 标头中的值。 |
字符串 |
Microsoft.Network/networkWatchers/connectionMonitors