Microsoft.Network networkWatchers/connectionMonitors 2022-09-01
Bicep-Ressourcendefinition
Der Ressourcentyp networkWatchers/connectionMonitors kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Network/networkWatchers/connectionMonitors-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.Network/networkWatchers/connectionMonitors@2022-09-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
autoStart: bool
destination: {
address: 'string'
port: int
resourceId: 'string'
}
endpoints: [
{
address: 'string'
coverageLevel: 'string'
filter: {
items: [
{
address: 'string'
type: 'AgentAddress'
}
]
type: 'Include'
}
name: 'string'
resourceId: 'string'
scope: {
exclude: [
{
address: 'string'
}
]
include: [
{
address: 'string'
}
]
}
type: 'string'
}
]
monitoringIntervalInSeconds: int
notes: 'string'
outputs: [
{
type: 'Workspace'
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'
]
}
]
}
}
Eigenschaftswerte
networkWatchers/connectionMonitors
Name | BESCHREIBUNG | Wert |
---|---|---|
name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep. |
Zeichenfolge (erforderlich) |
location | Speicherort des Verbindungsmonitors. | Zeichenfolge |
tags | Verbindungsmonitortags. | Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen. |
parent | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource vom Typ: networkWatchers |
properties | Eigenschaften des Verbindungsmonitors. | ConnectionMonitorParametersOrConnectionMonitorResult... (erforderlich) |
ConnectionMonitorParametersOrConnectionMonitorResult...
Name | BESCHREIBUNG | Wert |
---|---|---|
autoStart | Bestimmt, ob der Verbindungsmonitor nach der Erstellung automatisch gestartet wird. | bool |
destination | Beschreibt das Ziel des Verbindungsmonitors. | ConnectionMonitorDestination |
-Endpunkte | Liste der Endpunkte des Verbindungsmonitors. | ConnectionMonitorEndpoint[] |
monitoringIntervalInSeconds | Überwachungsintervall in Sekunden. | INT Einschränkungen: Minimaler Wert = 30 Maximaler Wert = 1800 |
notes | Optionale Hinweise, die dem Verbindungsmonitor zugeordnet werden sollen. | Zeichenfolge |
outputs | Liste der Ausgaben des Verbindungsmonitors. | ConnectionMonitorOutput[] |
source | Beschreibt die Quelle des Verbindungsmonitors. | ConnectionMonitorSource |
testConfigurations | Liste der Testkonfigurationen des Verbindungsmonitors. | ConnectionMonitorTestConfiguration[] |
testGroups | Liste der Testgruppen des Verbindungsmonitors. | ConnectionMonitorTestGroup[] |
ConnectionMonitorDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
address | Adresse des Verbindungsmonitorziels (IP- oder Domänenname). | Zeichenfolge |
port | Der vom Verbindungsmonitor verwendete Zielport. | INT Einschränkungen: Minimaler Wert = 0 Maximaler Wert = 65535 |
resourceId | Die ID der Ressource, die vom Verbindungsmonitor als Ziel verwendet wird. | Zeichenfolge |
ConnectionMonitorEndpoint
Name | BESCHREIBUNG | Wert |
---|---|---|
address | Adresse des Endpunkts des Verbindungsmonitors (IP- oder Domänenname). | Zeichenfolge |
coverageLevel | Testabdeckung für den Endpunkt. | "AboveAverage" "Durchschnitt" 'BelowAverage' 'Standardwert' 'Full' "Niedrig" |
filter | Filtern Sie nach Unterelementen innerhalb des Endpunkts. | ConnectionMonitorEndpointFilter |
name | Der Name des Verbindungsmonitorendpunkts. | Zeichenfolge (erforderlich) |
resourceId | Ressourcen-ID des Verbindungsmonitorendpunkts. | Zeichenfolge |
scope | Endpunktbereich. | ConnectionMonitorEndpointScope |
Typ | Der Endpunkttyp. | "AzureArcVM" "AzureSubnet" "AzureVM" "AzureVMSS" "AzureVNet" "ExternalAddress" 'MMAWorkspaceMachine' 'MMAWorkspaceNetwork' |
ConnectionMonitorEndpointFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
items | Liste der Elemente im Filter. | ConnectionMonitorEndpointFilterItem[] |
Typ | Das Verhalten des Endpunktfilters. Derzeit wird nur "Include" unterstützt. | "Einschließen" |
ConnectionMonitorEndpointFilterItem
Name | BESCHREIBUNG | Wert |
---|---|---|
address | Die Adresse des Filterelements. | Zeichenfolge |
type | Der Typ des elements, das im Filter enthalten ist. Derzeit wird nur "AgentAddress" unterstützt. | "AgentAddress" |
ConnectionMonitorEndpointScope
Name | BESCHREIBUNG | Wert |
---|---|---|
Ausschließen | Liste der Elemente, die aus dem Endpunktbereich ausgeschlossen werden müssen. | ConnectionMonitorEndpointScopeItem[] |
include | Liste der Elemente, die in den Endpunktbereich aufgenommen werden müssen. | ConnectionMonitorEndpointScopeItem[] |
ConnectionMonitorEndpointScopeItem
Name | BESCHREIBUNG | Wert |
---|---|---|
address | Die Adresse des Endpunktelements. Unterstützte Typen sind IPv4/IPv6-Subnetzmaske oder IPv4/IPv6-IP-Adresse. | Zeichenfolge |
ConnectionMonitorOutput
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Ausgabezieltyp des Verbindungsmonitors. Derzeit wird nur "Arbeitsbereich" unterstützt. | "Arbeitsbereich" |
workspaceSettings | Beschreibt die Einstellungen zum Erstellen einer Ausgabe in einem Log Analytics-Arbeitsbereich. | ConnectionMonitorWorkspaceSettings |
ConnectionMonitorWorkspaceSettings
Name | BESCHREIBUNG | Wert |
---|---|---|
workspaceResourceId | Ressourcen-ID des Log Analytics-Arbeitsbereichs. | Zeichenfolge |
ConnectionMonitorSource
Name | BESCHREIBUNG | Wert |
---|---|---|
port | Der vom Verbindungsmonitor verwendete Quellport. | INT Einschränkungen: Minimaler Wert = 0 Maximaler Wert = 65535 |
resourceId | Die ID der Ressource, die vom Verbindungsmonitor als Quelle verwendet wird. | Zeichenfolge (erforderlich) |
ConnectionMonitorTestConfiguration
Name | BESCHREIBUNG | Wert |
---|---|---|
httpConfiguration | Die Parameter, die zum Ausführen der Testauswertung über HTTP verwendet werden. | ConnectionMonitorHttpConfiguration |
icmpConfiguration | Die Parameter, die zum Ausführen der Testauswertung über ICMP verwendet werden. | ConnectionMonitorIcmpConfiguration |
name | Der Name der Testkonfiguration des Verbindungsmonitors. | Zeichenfolge (erforderlich) |
preferredIPVersion | Die bevorzugte IP-Version, die bei der Testauswertung verwendet werden soll. Der Verbindungsmonitor kann je nach anderen Parametern eine andere Version verwenden. | "IPv4" "IPv6" |
Protokoll | Das Protokoll, das bei der Testauswertung verwendet werden soll. | "HTTP" "Icmp" "TCP" (erforderlich) |
successThreshold | Der Schwellenwert für die Deklaration eines erfolgreichen Tests. | ConnectionMonitorSuccessThreshold |
tcpConfiguration | Die Parameter, die zum Ausführen der Testauswertung über TCP verwendet werden. | ConnectionMonitorTcpConfiguration |
testFrequencySec | Die Häufigkeit der Testauswertung in Sekunden. | INT |
ConnectionMonitorHttpConfiguration
Name | BESCHREIBUNG | Wert |
---|---|---|
method | Die zu verwendende HTTP-Methode. | "Get" "Post" |
path | Die Pfadkomponente des URI. Für instance : "/dir1/dir2". | Zeichenfolge |
port | Der Port, mit dem eine Verbindung hergestellt werden soll. | INT Einschränkungen: Minimaler Wert = 0 Maximaler Wert = 65535 |
preferHTTPS | Wert, der angibt, ob HTTPS gegenüber HTTP bevorzugt wird, wenn die Auswahl nicht explizit ist. | bool |
requestHeaders | Die HTTP-Header, die mit der Anforderung übertragen werden sollen. | HttpHeader[] |
validStatusCodeRanges | HTTP-status Codes, die als erfolgreich betrachtet werden sollen. Für instance "2xx.301-304.418". | string[] |
HttpHeader
Name | BESCHREIBUNG | Wert |
---|---|---|
name | Der Name im HTTP-Header. | Zeichenfolge |
value | Der Wert im HTTP-Header. | Zeichenfolge |
ConnectionMonitorIcmpConfiguration
Name | BESCHREIBUNG | Wert |
---|---|---|
disableTraceRoute | Wert, der angibt, ob die Pfadauswertung mit Ablaufverfolgungsroute deaktiviert werden soll. | bool |
ConnectionMonitorSuccessThreshold
Name | BESCHREIBUNG | Wert |
---|---|---|
checksFailedPercent | Der maximale Prozentsatz fehlerhafter Überprüfungen, die für einen Test als erfolgreich ausgewertet werden können. | INT |
roundTripTimeMs | Die maximale Roundtripzeit in Millisekunden, die für einen Test als erfolgreich bewertet werden kann. | INT |
ConnectionMonitorTcpConfiguration
Name | BESCHREIBUNG | Wert |
---|---|---|
destinationPortBehavior | Zielportverhalten. | "ListenIfAvailable" "Keine" |
disableTraceRoute | Wert, der angibt, ob die Pfadauswertung mit Ablaufverfolgungsroute deaktiviert werden soll. | bool |
port | Der Port, mit dem eine Verbindung hergestellt werden soll. | INT Einschränkungen: Minimaler Wert = 0 Maximaler Wert = 65535 |
ConnectionMonitorTestGroup
Name | BESCHREIBUNG | Wert |
---|---|---|
destinations | Liste der Zielendpunktnamen. | string[] (erforderlich) |
disable | Wert, der angibt, ob die Testgruppe deaktiviert ist. | bool |
name | Der Name der Testgruppe des Verbindungsmonitors. | Zeichenfolge (erforderlich) |
sources | Liste der Namen des Quellendpunkts. | string[] (erforderlich) |
testConfigurations | Liste der Testkonfigurationsnamen. | string[] (erforderlich) |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp networkWatchers/connectionMonitors kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Network/networkWatchers/connectionMonitors-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.Network/networkWatchers/connectionMonitors",
"apiVersion": "2022-09-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"autoStart": "bool",
"destination": {
"address": "string",
"port": "int",
"resourceId": "string"
},
"endpoints": [
{
"address": "string",
"coverageLevel": "string",
"filter": {
"items": [
{
"address": "string",
"type": "AgentAddress"
}
],
"type": "Include"
},
"name": "string",
"resourceId": "string",
"scope": {
"exclude": [
{
"address": "string"
}
],
"include": [
{
"address": "string"
}
]
},
"type": "string"
}
],
"monitoringIntervalInSeconds": "int",
"notes": "string",
"outputs": [
{
"type": "Workspace",
"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" ]
}
]
}
}
Eigenschaftswerte
networkWatchers/connectionMonitors
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Der Ressourcentyp | "Microsoft.Network/networkWatchers/connectionMonitors" |
apiVersion | Die Version der Ressourcen-API | '2022-09-01' |
name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen. |
Zeichenfolge (erforderlich) |
location | Speicherort des Verbindungsmonitors. | Zeichenfolge |
tags | Verbindungsmonitortags. | Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen. |
properties | Eigenschaften des Verbindungsmonitors. | ConnectionMonitorParametersOrConnectionMonitorResult... (erforderlich) |
ConnectionMonitorParametersOrConnectionMonitorResult...
Name | BESCHREIBUNG | Wert |
---|---|---|
autoStart | Bestimmt, ob der Verbindungsmonitor nach der Erstellung automatisch gestartet wird. | bool |
destination | Beschreibt das Ziel des Verbindungsmonitors. | ConnectionMonitorDestination |
-Endpunkte | Liste der Endpunkte des Verbindungsmonitors. | ConnectionMonitorEndpoint[] |
monitoringIntervalInSeconds | Überwachungsintervall in Sekunden. | INT Einschränkungen: Minimaler Wert = 30 Maximaler Wert = 1800 |
notes | Optionale Hinweise, die dem Verbindungsmonitor zugeordnet werden sollen. | Zeichenfolge |
outputs | Liste der Ausgaben des Verbindungsmonitors. | ConnectionMonitorOutput[] |
source | Beschreibt die Quelle des Verbindungsmonitors. | ConnectionMonitorSource |
testConfigurations | Liste der Testkonfigurationen des Verbindungsmonitors. | ConnectionMonitorTestConfiguration[] |
testGroups | Liste der Testgruppen des Verbindungsmonitors. | ConnectionMonitorTestGroup[] |
ConnectionMonitorDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
address | Adresse des Verbindungsmonitorziels (IP- oder Domänenname). | Zeichenfolge |
port | Der vom Verbindungsmonitor verwendete Zielport. | INT Einschränkungen: Min-Wert = 0 Maximaler Wert = 65535 |
resourceId | Die ID der Ressource, die vom Verbindungsmonitor als Ziel verwendet wird. | Zeichenfolge |
ConnectionMonitorEndpoint
Name | BESCHREIBUNG | Wert |
---|---|---|
address | Adresse des Endpunkts des Verbindungsmonitors (IP- oder Domänenname). | Zeichenfolge |
coverageLevel | Testabdeckung für den Endpunkt. | "AboveAverage" "Durchschnitt" 'BelowAverage' 'Standardwert' 'Full' "Niedrig" |
filter | Filtern Sie nach Unterelementen innerhalb des Endpunkts. | ConnectionMonitorEndpointFilter |
name | Der Name des Verbindungsmonitorendpunkts. | Zeichenfolge (erforderlich) |
resourceId | Ressourcen-ID des Verbindungsmonitorendpunkts. | Zeichenfolge |
scope | Endpunktbereich. | ConnectionMonitorEndpointScope |
Typ | Der Endpunkttyp. | "AzureArcVM" "AzureSubnet" "AzureVM" "AzureVMSS" "AzureVNet" "ExternalAddress" 'MMAWorkspaceMachine' 'MMAWorkspaceNetwork' |
ConnectionMonitorEndpointFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
items | Liste der Elemente im Filter. | ConnectionMonitorEndpointFilterItem[] |
Typ | Das Verhalten des Endpunktfilters. Derzeit wird nur "Include" unterstützt. | "Einschließen" |
ConnectionMonitorEndpointFilterItem
Name | BESCHREIBUNG | Wert |
---|---|---|
address | Die Adresse des Filterelements. | Zeichenfolge |
type | Der Typ des elements, das im Filter enthalten ist. Derzeit wird nur "AgentAddress" unterstützt. | "AgentAddress" |
ConnectionMonitorEndpointScope
Name | BESCHREIBUNG | Wert |
---|---|---|
Ausschließen | Liste der Elemente, die aus dem Endpunktbereich ausgeschlossen werden müssen. | ConnectionMonitorEndpointScopeItem[] |
include | Liste der Elemente, die in den Endpunktbereich aufgenommen werden müssen. | ConnectionMonitorEndpointScopeItem[] |
ConnectionMonitorEndpointScopeItem
Name | BESCHREIBUNG | Wert |
---|---|---|
address | Die Adresse des Endpunktelements. Unterstützte Typen sind IPv4/IPv6-Subnetzmaske oder IPv4/IPv6-IP-Adresse. | Zeichenfolge |
ConnectionMonitorOutput
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Ausgabezieltyp des Verbindungsmonitors. Derzeit wird nur "Arbeitsbereich" unterstützt. | "Arbeitsbereich" |
workspaceSettings | Beschreibt die Einstellungen zum Erstellen einer Ausgabe in einem Log Analytics-Arbeitsbereich. | ConnectionMonitorWorkspaceSettings |
ConnectionMonitorWorkspaceSettings
Name | BESCHREIBUNG | Wert |
---|---|---|
workspaceResourceId | Ressourcen-ID des Log Analytics-Arbeitsbereichs. | Zeichenfolge |
ConnectionMonitorSource
Name | BESCHREIBUNG | Wert |
---|---|---|
port | Der Vom Verbindungsmonitor verwendete Quellport. | INT Einschränkungen: Min-Wert = 0 Maximaler Wert = 65535 |
resourceId | Die ID der Ressource, die vom Verbindungsmonitor als Quelle verwendet wird. | Zeichenfolge (erforderlich) |
ConnectionMonitorTestConfiguration
Name | BESCHREIBUNG | Wert |
---|---|---|
httpConfiguration | Die Parameter, die zum Durchführen der Testauswertung über HTTP verwendet werden. | ConnectionMonitorHttpConfiguration |
icmpConfiguration | Die Parameter, die zum Durchführen der Testauswertung über ICMP verwendet werden. | ConnectionMonitorIcmpConfiguration |
name | Der Name der Testkonfiguration des Verbindungsmonitors. | Zeichenfolge (erforderlich) |
preferredIPVersion | Die bevorzugte IP-Version, die bei der Testauswertung verwendet werden soll. Der Verbindungsmonitor kann je nach anderen Parametern eine andere Version verwenden. | "IPv4" "IPv6" |
Protokoll | Das Protokoll, das bei der Testauswertung verwendet werden soll. | Http "Icmp" "TCP" (erforderlich) |
successThreshold | Der Schwellenwert für die Deklarierung eines erfolgreichen Tests. | ConnectionMonitorSuccessThreshold |
tcpConfiguration | Die Parameter, die zum Ausführen der Testauswertung über TCP verwendet werden. | ConnectionMonitorTcpConfiguration |
testFrequencySec | Die Häufigkeit der Testauswertung in Sekunden. | INT |
ConnectionMonitorHttpConfiguration
Name | BESCHREIBUNG | Wert |
---|---|---|
method | Die zu verwendende HTTP-Methode. | "Get" "Post" |
path | Die Pfadkomponente des URI. Für instance "/dir1/dir2". | Zeichenfolge |
port | Der Port, mit dem eine Verbindung hergestellt werden soll. | INT Einschränkungen: Min-Wert = 0 Maximaler Wert = 65535 |
preferHTTPS | Wert, der angibt, ob HTTPS gegenüber HTTP bevorzugt wird, wenn die Auswahl nicht explizit ist. | bool |
requestHeaders | Die HTTP-Header, die mit der Anforderung übertragen werden sollen. | HttpHeader[] |
validStatusCodeRanges | HTTP-status Codes, die als erfolgreich betrachtet werden sollen. Für instance "2xx.301-304.418". | string[] |
HttpHeader
Name | BESCHREIBUNG | Wert |
---|---|---|
name | Der Name im HTTP-Header. | Zeichenfolge |
value | Der Wert im HTTP-Header. | Zeichenfolge |
ConnectionMonitorIcmpConfiguration
Name | BESCHREIBUNG | Wert |
---|---|---|
disableTraceRoute | Wert, der angibt, ob die Pfadauswertung mit Ablaufverfolgungsroute deaktiviert werden soll. | bool |
ConnectionMonitorSuccessThreshold
Name | BESCHREIBUNG | Wert |
---|---|---|
checksFailedPercent | Der maximale Prozentsatz fehlerhafter Überprüfungen, die für einen Test als erfolgreich ausgewertet werden können. | INT |
roundTripTimeMs | Die maximale Roundtripzeit in Millisekunden, die für einen Test als erfolgreich bewertet werden kann. | INT |
ConnectionMonitorTcpConfiguration
Name | BESCHREIBUNG | Wert |
---|---|---|
destinationPortBehavior | Zielportverhalten. | "ListenIfAvailable" "Keine" |
disableTraceRoute | Wert, der angibt, ob die Pfadauswertung mit Ablaufverfolgungsroute deaktiviert werden soll. | bool |
port | Der Port, mit dem eine Verbindung hergestellt werden soll. | INT Einschränkungen: Minimaler Wert = 0 Maximaler Wert = 65535 |
ConnectionMonitorTestGroup
Name | BESCHREIBUNG | Wert |
---|---|---|
destinations | Liste der Zielendpunktnamen. | string[] (erforderlich) |
disable | Wert, der angibt, ob die Testgruppe deaktiviert ist. | bool |
name | Der Name der Testgruppe des Verbindungsmonitors. | Zeichenfolge (erforderlich) |
sources | Liste der Namen des Quellendpunkts. | string[] (erforderlich) |
testConfigurations | Liste der Testkonfigurationsnamen. | string[] (erforderlich) |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp networkWatchers/connectionMonitors kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Network/networkWatchers/connectionMonitors-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkWatchers/connectionMonitors@2022-09-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
autoStart = bool
destination = {
address = "string"
port = int
resourceId = "string"
}
endpoints = [
{
address = "string"
coverageLevel = "string"
filter = {
items = [
{
address = "string"
type = "AgentAddress"
}
]
type = "Include"
}
name = "string"
resourceId = "string"
scope = {
exclude = [
{
address = "string"
}
]
include = [
{
address = "string"
}
]
}
type = "string"
}
]
monitoringIntervalInSeconds = int
notes = "string"
outputs = [
{
type = "Workspace"
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"
]
}
]
}
})
}
Eigenschaftswerte
networkWatchers/connectionMonitors
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Der Ressourcentyp | "Microsoft.Network/networkWatchers/connectionMonitors@2022-09-01" |
name | Der Ressourcenname | Zeichenfolge (erforderlich) |
location | Speicherort des Verbindungsmonitors. | Zeichenfolge |
parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource vom Typ : networkWatchers |
tags | Verbindungsmonitortags. | Wörterbuch der Tagnamen und -werte. |
properties | Eigenschaften des Verbindungsmonitors. | ConnectionMonitorParametersOrConnectionMonitorResult... (erforderlich) |
ConnectionMonitorParametersOrConnectionMonitorResult...
Name | BESCHREIBUNG | Wert |
---|---|---|
autoStart | Bestimmt, ob der Verbindungsmonitor nach der Erstellung automatisch gestartet wird. | bool |
destination | Beschreibt das Ziel des Verbindungsmonitors. | ConnectionMonitorDestination |
-Endpunkte | Liste der Endpunkte des Verbindungsmonitors. | ConnectionMonitorEndpoint[] |
monitoringIntervalInSeconds | Überwachungsintervall in Sekunden. | INT Einschränkungen: Minimaler Wert = 30 Maximaler Wert = 1800 |
notes | Optionale Hinweise, die dem Verbindungsmonitor zugeordnet werden sollen. | Zeichenfolge |
outputs | Liste der Ausgaben des Verbindungsmonitors. | ConnectionMonitorOutput[] |
source | Beschreibt die Quelle des Verbindungsmonitors. | ConnectionMonitorSource |
testConfigurations | Liste der Testkonfigurationen des Verbindungsmonitors. | ConnectionMonitorTestConfiguration[] |
testGroups | Liste der Verbindungsmonitor-Testgruppen. | ConnectionMonitorTestGroup[] |
ConnectionMonitorDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
address | Adresse des Verbindungsmonitorziels (IP- oder Domänenname). | Zeichenfolge |
port | Der vom Verbindungsmonitor verwendete Zielport. | INT Einschränkungen: Min-Wert = 0 Maximaler Wert = 65535 |
resourceId | Die ID der Ressource, die vom Verbindungsmonitor als Ziel verwendet wird. | Zeichenfolge |
ConnectionMonitorEndpoint
Name | BESCHREIBUNG | Wert |
---|---|---|
address | Adresse des Endpunkts des Verbindungsmonitors (IP- oder Domänenname). | Zeichenfolge |
coverageLevel | Testabdeckung für den Endpunkt. | "AboveAverage" "Durchschnitt" "BelowAverage" "Standard" "Voll" "Low" |
filter | Filtern Sie nach Unterelementen innerhalb des Endpunkts. | ConnectionMonitorEndpointFilter |
name | Der Name des Verbindungsmonitorendpunkts. | Zeichenfolge (erforderlich) |
resourceId | Ressourcen-ID des Verbindungsmonitorendpunkts. | Zeichenfolge |
scope | Endpunktbereich. | ConnectionMonitorEndpointScope |
Typ | Der Endpunkttyp. | "AzureArcVM" "AzureSubnet" "AzureVM" "AzureVMSS" "AzureVNet" "ExternalAddress" "MMAWorkspaceMachine" "MMAWorkspaceNetwork" |
ConnectionMonitorEndpointFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
items | Liste der Elemente im Filter. | ConnectionMonitorEndpointFilterItem[] |
Typ | Das Verhalten des Endpunktfilters. Derzeit wird nur "Include" unterstützt. | "Einschließen" |
ConnectionMonitorEndpointFilterItem
Name | BESCHREIBUNG | Wert |
---|---|---|
address | Die Adresse des Filterelements. | Zeichenfolge |
type | Der Typ des elements, das im Filter enthalten ist. Derzeit wird nur "AgentAddress" unterstützt. | "AgentAddress" |
ConnectionMonitorEndpointScope
Name | BESCHREIBUNG | Wert |
---|---|---|
Ausschließen | Liste der Elemente, die aus dem Endpunktbereich ausgeschlossen werden müssen. | ConnectionMonitorEndpointScopeItem[] |
include | Liste der Elemente, die in den Endpunktbereich aufgenommen werden müssen. | ConnectionMonitorEndpointScopeItem[] |
ConnectionMonitorEndpointScopeItem
Name | BESCHREIBUNG | Wert |
---|---|---|
address | Die Adresse des Endpunktelements. Unterstützte Typen sind IPv4/IPv6-Subnetzmaske oder IPv4/IPv6-IP-Adresse. | Zeichenfolge |
ConnectionMonitorOutput
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Ausgabezieltyp des Verbindungsmonitors. Derzeit wird nur "Arbeitsbereich" unterstützt. | "Arbeitsbereich" |
workspaceSettings | Beschreibt die Einstellungen zum Erstellen von Ausgaben in einem Log Analytics-Arbeitsbereich. | ConnectionMonitorWorkspaceSettings |
ConnectionMonitorWorkspaceSettings
Name | BESCHREIBUNG | Wert |
---|---|---|
workspaceResourceId | Ressourcen-ID des Log Analytics-Arbeitsbereichs. | Zeichenfolge |
ConnectionMonitorSource
Name | BESCHREIBUNG | Wert |
---|---|---|
port | Der vom Verbindungsmonitor verwendete Quellport. | INT Einschränkungen: Minimaler Wert = 0 Maximaler Wert = 65535 |
resourceId | Die ID der Ressource, die vom Verbindungsmonitor als Quelle verwendet wird. | Zeichenfolge (erforderlich) |
ConnectionMonitorTestConfiguration
Name | BESCHREIBUNG | Wert |
---|---|---|
httpConfiguration | Die Parameter, die zum Ausführen der Testauswertung über HTTP verwendet werden. | ConnectionMonitorHttpConfiguration |
icmpConfiguration | Die Parameter, die zum Ausführen der Testauswertung über ICMP verwendet werden. | ConnectionMonitorIcmpConfiguration |
name | Der Name der Testkonfiguration des Verbindungsmonitors. | Zeichenfolge (erforderlich) |
preferredIPVersion | Die bevorzugte IP-Version, die bei der Testauswertung verwendet werden soll. Der Verbindungsmonitor kann je nach anderen Parametern eine andere Version verwenden. | "IPv4" "IPv6" |
Protokoll | Das Protokoll, das bei der Testauswertung verwendet werden soll. | "HTTP" "Icmp" "TCP" (erforderlich) |
successThreshold | Der Schwellenwert für die Deklaration eines erfolgreichen Tests. | ConnectionMonitorSuccessThreshold |
tcpConfiguration | Die Parameter, die zum Ausführen der Testauswertung über TCP verwendet werden. | ConnectionMonitorTcpConfiguration |
testFrequencySec | Die Häufigkeit der Testauswertung in Sekunden. | INT |
ConnectionMonitorHttpConfiguration
Name | BESCHREIBUNG | Wert |
---|---|---|
method | Die zu verwendende HTTP-Methode. | "Get" "Post" |
path | Die Pfadkomponente des URI. Für instance : "/dir1/dir2". | Zeichenfolge |
port | Der Port, mit dem eine Verbindung hergestellt werden soll. | INT Einschränkungen: Minimaler Wert = 0 Maximaler Wert = 65535 |
preferHTTPS | Wert, der angibt, ob HTTPS gegenüber HTTP bevorzugt wird, wenn die Auswahl nicht explizit ist. | bool |
requestHeaders | Die HTTP-Header, die mit der Anforderung übertragen werden sollen. | HttpHeader[] |
validStatusCodeRanges | HTTP-status Codes, die als erfolgreich betrachtet werden sollen. Für instance "2xx.301-304.418". | string[] |
HttpHeader
Name | BESCHREIBUNG | Wert |
---|---|---|
name | Der Name im HTTP-Header. | Zeichenfolge |
value | Der Wert im HTTP-Header. | Zeichenfolge |
ConnectionMonitorIcmpConfiguration
Name | BESCHREIBUNG | Wert |
---|---|---|
disableTraceRoute | Wert, der angibt, ob die Pfadauswertung mit Ablaufverfolgungsroute deaktiviert werden soll. | bool |
ConnectionMonitorSuccessThreshold
Name | BESCHREIBUNG | Wert |
---|---|---|
checksFailedPercent | Der maximale Prozentsatz der fehlerhaften Überprüfungen, die für einen Test als erfolgreich bewertet werden dürfen. | INT |
roundTripTimeMs | Die maximale Roundtripzeit in Millisekunden, die für einen Test als erfolgreich bewertet werden kann. | INT |
ConnectionMonitorTcpConfiguration
Name | BESCHREIBUNG | Wert |
---|---|---|
destinationPortBehavior | Zielportverhalten. | "ListenIfAvailable" "None" |
disableTraceRoute | Wert, der angibt, ob die Pfadauswertung mit Ablaufverfolgungsroute deaktiviert werden soll. | bool |
port | Der Port, mit dem eine Verbindung hergestellt werden soll. | INT Einschränkungen: Min-Wert = 0 Maximaler Wert = 65535 |
ConnectionMonitorTestGroup
Name | BESCHREIBUNG | Wert |
---|---|---|
destinations | Liste der Namen des Zielendpunkts. | string[] (erforderlich) |
disable | Wert, der angibt, ob die Testgruppe deaktiviert ist. | bool |
name | Der Name der Testgruppe des Verbindungsmonitors. | Zeichenfolge (erforderlich) |
sources | Liste der Namen des Quellendpunkts. | string[] (erforderlich) |
testConfigurations | Liste der Testkonfigurationsnamen. | string[] (erforderlich) |