Network Watchers - Get VM Security Rules

Ruft die konfigurierten und effektiven Sicherheitsgruppenregeln auf der angegebenen VM ab.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/securityGroupView?api-version=2023-09-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
networkWatcherName
path True

string

Der Name des Network Watchers.

resourceGroupName
path True

string

Der Name der Ressourcengruppe.

subscriptionId
path True

string

Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True

string

Client-API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
targetResourceId True

string

ID der Ziel-VM.

Antworten

Name Typ Beschreibung
200 OK

SecurityGroupViewResult

Anforderung erfolgreich. Der Vorgang gibt Sicherheitsgruppenregeln auf dem virtuellen Computer zurück.

202 Accepted

SecurityGroupViewResult

Akzeptiert, und der Vorgang wird asynchron abgeschlossen.

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Get security group view

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/securityGroupView?api-version=2023-09-01

{
  "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"
}

Sample Response

{
  "networkInterfaces": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1",
      "securityRuleAssociations": {
        "subnetAssociation": {
          "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
          "securityRules": [
            {
              "name": "fe_rule",
              "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/AppNSG/securityRules/fe_rule",
              "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
              "properties": {
                "provisioningState": "Succeeded",
                "description": "Allow Frontend",
                "protocol": "Tcp",
                "sourcePortRange": "*",
                "destinationPortRange": "*",
                "sourceAddressPrefix": "10.1.0.0/24",
                "destinationAddressPrefix": "*",
                "access": "Allow",
                "priority": 100,
                "direction": "Inbound"
              }
            }
          ]
        },
        "defaultSecurityRules": [
          {
            "name": "AllowVnetInBound",
            "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/networkSecurityGroups//defaultSecurityRules/",
            "properties": {
              "provisioningState": "Succeeded",
              "description": "Allow inbound traffic from all VMs in VNET",
              "protocol": "*",
              "sourcePortRange": "*",
              "destinationPortRange": "*",
              "sourceAddressPrefix": "VirtualNetwork",
              "destinationAddressPrefix": "VirtualNetwork",
              "access": "Allow",
              "priority": 65000,
              "direction": "Inbound"
            }
          }
        ],
        "effectiveSecurityRules": [
          {
            "name": "DefaultOutboundDenyAll",
            "protocol": "All",
            "sourcePortRange": "0-65535",
            "destinationPortRange": "0-65535",
            "sourceAddressPrefix": "*",
            "destinationAddressPrefix": "*",
            "access": "Deny",
            "priority": 65500,
            "direction": "Outbound"
          }
        ]
      }
    }
  ]
}
Location: https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/queryStatus?api-version=2023-09-01
{
  "networkInterfaces": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1",
      "securityRuleAssociations": {
        "subnetAssociation": {
          "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
          "securityRules": [
            {
              "name": "fe_rule",
              "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/AppNSG/securityRules/fe_rule",
              "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
              "properties": {
                "provisioningState": "Succeeded",
                "description": "Allow Frontend",
                "protocol": "Tcp",
                "sourcePortRange": "*",
                "destinationPortRange": "*",
                "sourceAddressPrefix": "10.1.0.0/24",
                "destinationAddressPrefix": "*",
                "access": "Allow",
                "priority": 100,
                "direction": "Inbound"
              }
            }
          ]
        },
        "defaultSecurityRules": [
          {
            "name": "AllowVnetInBound",
            "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/networkSecurityGroups//defaultSecurityRules/",
            "properties": {
              "provisioningState": "Succeeded",
              "description": "Allow inbound traffic from all VMs in VNET",
              "protocol": "*",
              "sourcePortRange": "*",
              "destinationPortRange": "*",
              "sourceAddressPrefix": "VirtualNetwork",
              "destinationAddressPrefix": "VirtualNetwork",
              "access": "Allow",
              "priority": 65000,
              "direction": "Inbound"
            }
          }
        ],
        "effectiveSecurityRules": [
          {
            "name": "DefaultOutboundDenyAll",
            "protocol": "All",
            "sourcePortRange": "0-65535",
            "destinationPortRange": "0-65535",
            "sourceAddressPrefix": "*",
            "destinationAddressPrefix": "*",
            "access": "Deny",
            "priority": 65500,
            "direction": "Outbound"
          }
        ]
      }
    }
  ]
}

Definitionen

Name Beschreibung
ApplicationSecurityGroup

Eine Anwendungssicherheitsgruppe in einer Ressourcengruppe.

EffectiveNetworkSecurityRule

Effektive Netzwerksicherheitsregeln.

EffectiveSecurityRuleProtocol

Das Netzwerkprotokoll, für das diese Regel gilt.

ErrorDetails

Allgemeine Darstellung von Fehlerdetails.

ErrorResponse

Das Fehlerobjekt.

NetworkInterfaceAssociation

Netzwerkschnittstelle und ihre benutzerdefinierten Sicherheitsregeln.

ProvisioningState

Der aktuelle Bereitstellungsstatus.

SecurityGroupNetworkInterface

Netzwerkschnittstelle und alle zugehörigen Sicherheitsregeln.

SecurityGroupViewParameters

Parameter, die den virtuellen Computer definieren, auf den Sicherheitsgruppen überprüft werden sollen.

SecurityGroupViewResult

Die Informationen zu Sicherheitsregeln, die auf den angegebenen virtuellen Computer angewendet werden.

SecurityRule

Netzwerksicherheitsregel.

SecurityRuleAccess

Gibt an, ob Netzwerkdatenverkehr zugelassen oder verweigert wird.

SecurityRuleAssociations

Alle Sicherheitsregeln, die der Netzwerkschnittstelle zugeordnet sind.

SecurityRuleDirection

Die Richtung der Regel. Die Richtung gibt an, ob die Regel bei eingehendem oder ausgehendem Datenverkehr ausgewertet wird.

SecurityRuleProtocol

Netzwerkprotokoll, für das diese Regel gilt.

SubnetAssociation

Subnetz und benutzerdefinierte Sicherheitsregeln.

ApplicationSecurityGroup

Eine Anwendungssicherheitsgruppe in einer Ressourcengruppe.

Name Typ Beschreibung
etag

string

Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.

id

string

Ressourcen-ID

location

string

Ressourcenspeicherort

name

string

Name der Ressource.

properties.provisioningState

ProvisioningState

Der Bereitstellungsstatus der Anwendungssicherheitsgruppenressource.

properties.resourceGuid

string

Die Ressourcen-GUID-Eigenschaft der Anwendungssicherheitsgruppenressource. Es identifiziert eine Ressource eindeutig, auch wenn der Benutzer ihren Namen ändert oder die Ressource über Abonnements oder Ressourcengruppen hinweg migriert.

tags

object

Ressourcentags.

type

string

Der Ressourcentyp.

EffectiveNetworkSecurityRule

Effektive Netzwerksicherheitsregeln.

Name Typ Beschreibung
access

SecurityRuleAccess

Gibt an, ob Netzwerkdatenverkehr zugelassen oder verweigert wird.

destinationAddressPrefix

string

Das Zieladresspräfix.

destinationAddressPrefixes

string[]

Die Zieladresspräfixe. Zu den erwarteten Werten gehören CIDR-IP-Bereiche, Standardtags (VirtualNetwork, AzureLoadBalancer, Internet), Systemtags und das Sternchen (*).

destinationPortRange

string

Der Zielport oder -bereich.

destinationPortRanges

string[]

Die Zielportbereiche. Zu den erwarteten Werten gehören eine einzelne ganze Zahl zwischen 0 und 65535, ein Bereich mit "-" als Trennzeichen (z. B. 100-400) oder ein Sternchen (*).

direction

SecurityRuleDirection

Die Richtung der Regel.

expandedDestinationAddressPrefix

string[]

Erweitertes Zieladresspräfix.

expandedSourceAddressPrefix

string[]

Das erweiterte Quelladresspräfix.

name

string

Der Name der vom Benutzer angegebenen Sicherheitsregel (sofern vom Benutzer erstellt).

priority

integer

Die Priorität der Regel.

protocol

EffectiveSecurityRuleProtocol

Das Netzwerkprotokoll, für das diese Regel gilt.

sourceAddressPrefix

string

Das Quelladresspräfix.

sourceAddressPrefixes

string[]

Die Quelladresspräfixe. Zu den erwarteten Werten gehören CIDR-IP-Bereiche, Standardtags (VirtualNetwork, AzureLoadBalancer, Internet), Systemtags und das Sternchen (*).

sourcePortRange

string

Der Quellport oder -bereich.

sourcePortRanges

string[]

Die Quellportbereiche. Zu den erwarteten Werten gehören eine einzelne ganze Zahl zwischen 0 und 65535, ein Bereich mit "-" als Trennzeichen (z. B. 100-400) oder ein Sternchen (*).

EffectiveSecurityRuleProtocol

Das Netzwerkprotokoll, für das diese Regel gilt.

Name Typ Beschreibung
All

string

Tcp

string

Udp

string

ErrorDetails

Allgemeine Darstellung von Fehlerdetails.

Name Typ Beschreibung
code

string

Fehlercode

message

string

Fehlermeldung.

target

string

Fehlerziel.

ErrorResponse

Das Fehlerobjekt.

Name Typ Beschreibung
error

ErrorDetails

Fehler
Das Fehlerdetails-Objekt.

NetworkInterfaceAssociation

Netzwerkschnittstelle und ihre benutzerdefinierten Sicherheitsregeln.

Name Typ Beschreibung
id

string

Netzwerkschnittstellen-ID.

securityRules

SecurityRule[]

Sammlung von benutzerdefinierten Sicherheitsregeln.

ProvisioningState

Der aktuelle Bereitstellungsstatus.

Name Typ Beschreibung
Deleting

string

Failed

string

Succeeded

string

Updating

string

SecurityGroupNetworkInterface

Netzwerkschnittstelle und alle zugehörigen Sicherheitsregeln.

Name Typ Beschreibung
id

string

ID der Netzwerkschnittstelle.

securityRuleAssociations

SecurityRuleAssociations

Alle Sicherheitsregeln, die der Netzwerkschnittstelle zugeordnet sind.

SecurityGroupViewParameters

Parameter, die den virtuellen Computer definieren, auf den Sicherheitsgruppen überprüft werden sollen.

Name Typ Beschreibung
targetResourceId

string

ID der Ziel-VM.

SecurityGroupViewResult

Die Informationen zu Sicherheitsregeln, die auf den angegebenen virtuellen Computer angewendet werden.

Name Typ Beschreibung
networkInterfaces

SecurityGroupNetworkInterface[]

Liste der Netzwerkschnittstellen auf dem angegebenen virtuellen Computer.

SecurityRule

Netzwerksicherheitsregel.

Name Typ Beschreibung
etag

string

Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.

id

string

Ressourcen-ID

name

string

Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.

properties.access

SecurityRuleAccess

Der Netzwerkdatenverkehr wird zugelassen oder verweigert.

properties.description

string

Eine Beschreibung für diese Regel. Auf 140 Zeichen beschränkt.

properties.destinationAddressPrefix

string

Das Zieladresspräfix. CIDR oder Ziel-IP-Bereich. Das Sternchen '*' kann auch verwendet werden, um alle Quell-IPs abzugleichen. Standardtags wie "VirtualNetwork", "AzureLoadBalancer" und "Internet" können ebenfalls verwendet werden.

properties.destinationAddressPrefixes

string[]

Die Zieladresspräfixe. CIDR- oder Ziel-IP-Bereiche.

properties.destinationApplicationSecurityGroups

ApplicationSecurityGroup[]

Die als Ziel angegebene Anwendungssicherheitsgruppe.

properties.destinationPortRange

string

Der Zielport oder -bereich. Ganze Zahl oder Bereich zwischen 0 und 65535. Sternchen "*" kann auch verwendet werden, um alle Ports abzugleichen.

properties.destinationPortRanges

string[]

Die Zielportbereiche.

properties.direction

SecurityRuleDirection

Die Richtung der Regel. Die Richtung gibt an, ob die Regel bei eingehendem oder ausgehendem Datenverkehr ausgewertet wird.

properties.priority

integer

Die Priorität der Regel. Der Wert kann zwischen 100 und 4096 sein. Die Prioritätsnummer muss für jede Regel in der Auflistung eindeutig sein. Je niedrigere die Prioritätsnummer ist, desto höher ist die Priorität der Regel.

properties.protocol

SecurityRuleProtocol

Netzwerkprotokoll, für das diese Regel gilt.

properties.provisioningState

ProvisioningState

Der Bereitstellungsstatus der Sicherheitsregelressource.

properties.sourceAddressPrefix

string

Der CIDR- oder Quell-IP-Bereich. Das Sternchen '*' kann auch verwendet werden, um alle Quell-IPs abzugleichen. Standardtags wie "VirtualNetwork", "AzureLoadBalancer" und "Internet" können ebenfalls verwendet werden. Wenn es sich um eine Eingangsregel handelt, gibt an, woher der Netzwerkdatenverkehr stammt.

properties.sourceAddressPrefixes

string[]

Die CIDR- oder Quell-IP-Bereiche.

properties.sourceApplicationSecurityGroups

ApplicationSecurityGroup[]

Die als Quelle angegebene Anwendungssicherheitsgruppe.

properties.sourcePortRange

string

Der Quellport oder -bereich. Ganze Zahl oder Bereich zwischen 0 und 65535. Sternchen "*" kann auch verwendet werden, um alle Ports abzugleichen.

properties.sourcePortRanges

string[]

Die Quellportbereiche.

type

string

Der Typ der Ressource.

SecurityRuleAccess

Gibt an, ob Netzwerkdatenverkehr zugelassen oder verweigert wird.

Name Typ Beschreibung
Allow

string

Deny

string

SecurityRuleAssociations

Alle Sicherheitsregeln, die der Netzwerkschnittstelle zugeordnet sind.

Name Typ Beschreibung
defaultSecurityRules

SecurityRule[]

Sammlung der Standardsicherheitsregeln der Netzwerksicherheitsgruppe.

effectiveSecurityRules

EffectiveNetworkSecurityRule[]

Sammlung effektiver Sicherheitsregeln.

networkInterfaceAssociation

NetworkInterfaceAssociation

Netzwerkschnittstelle und benutzerdefinierte Sicherheitsregeln.

subnetAssociation

SubnetAssociation

Subnetz und benutzerdefinierte Sicherheitsregeln.

SecurityRuleDirection

Die Richtung der Regel. Die Richtung gibt an, ob die Regel bei eingehendem oder ausgehendem Datenverkehr ausgewertet wird.

Name Typ Beschreibung
Inbound

string

Outbound

string

SecurityRuleProtocol

Netzwerkprotokoll, für das diese Regel gilt.

Name Typ Beschreibung
*

string

Ah

string

Esp

string

Icmp

string

Tcp

string

Udp

string

SubnetAssociation

Subnetz und benutzerdefinierte Sicherheitsregeln.

Name Typ Beschreibung
id

string

Subnetz-ID:

securityRules

SecurityRule[]

Sammlung von benutzerdefinierten Sicherheitsregeln.