Inbound Rules - List By Nat Gateway

Dienst:: Azure Stack HCI

API-Version:: 2026-04-01-preview

Listet alle eingehenden Regeln im angegebenen NAT-Gateway auf. Verwenden Sie die NextLink-Eigenschaft in der Antwort, um die nächste Seite mit eingehenden Regeln zu erhalten.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/natGateways/{natGatewayName}/inboundRules?api-version=2026-04-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
natGatewayName	path	True	string pattern: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$	Name des natischen Tores
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	InboundRuleListResult	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ListInboundRulesByNatGateway

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/natGateways/test-nat-gw/inboundRules?api-version=2026-04-01-preview

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "name": "rdp-inbound-rule",
      "type": "Microsoft.AzureStackHCI/natGateways/inboundRules",
      "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/natGateways/test-nat-gw/inboundRules/rdp-inbound-rule",
      "extendedLocation": {
        "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
        "type": "CustomLocation"
      },
      "properties": {
        "protocol": "Tcp",
        "frontendPort": 3389,
        "backendPort": 3389,
        "backendIPConfiguration": {
          "resourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic/ipConfigurations/ipconfig1"
        },
        "publicIPAddress": {
          "resourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/publicIPAddresses/test-public-ip"
        },
        "provisioningState": "Succeeded",
        "status": {
          "provisioningStatus": {
            "operationId": "12345678-1234-1234-1234-123456789012",
            "status": "Succeeded"
          }
        }
      }
    },
    {
      "name": "ssh-inbound-rule",
      "type": "Microsoft.AzureStackHCI/natGateways/inboundRules",
      "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/natGateways/test-nat-gw/inboundRules/ssh-inbound-rule",
      "extendedLocation": {
        "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
        "type": "CustomLocation"
      },
      "properties": {
        "protocol": "Tcp",
        "frontendPort": 22,
        "backendPort": 22,
        "backendIPConfiguration": {
          "resourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic-2/ipConfigurations/ipconfig1"
        },
        "publicIPAddress": {
          "resourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/publicIPAddresses/test-public-ip"
        },
        "provisioningState": "Succeeded",
        "status": {
          "provisioningStatus": {
            "operationId": "87654321-4321-4321-4321-210987654321",
            "status": "Succeeded"
          }
        }
      }
    }
  ]
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ExtendedLocation	Der komplexe Typ des erweiterten Standorts.
ExtendedLocationTypes	Der Typ von extendedLocation.
InboundNATRuleProtocol	Protokoll für eingehende NAT-Regeln
InboundRule	Die Definition der eingehenden Regel-Ressourcen.
InboundRuleListResult	Die Antwort einer InboundRule-Listenoperation.
InboundRuleProperties	Eigenschaften der eingehenden Regel – erweitert InboundNATRuleProperties um zusätzliche Statusverfolgung
InboundRuleStatus	Der beobachtete Zustand der eingehenden Regel
InboundRuleStatusProvisioningStatus	Bereitstellungsstatus der Inbound Rule
IPConfigurationArmReference	Die Azure Resource ID einer IPConfiguration-Ressource
ProvisioningStateEnum	Bereitstellungsstatus der Ressource.
PublicIPAddressArmReference	Die Azure Resource ID einer öffentlichen IP-Ressource
Status	Der Status des Vorgangs, der für die Ressource ausgeführt wurde [Erfolgreich, Fehlgeschlagen, InProgress]
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ExtendedLocation

Objekt

Der komplexe Typ des erweiterten Standorts.

Name	Typ	Beschreibung
name	string	Der Name des erweiterten Speicherorts.
type	ExtendedLocationTypes	Der Typ des erweiterten Speicherorts.

ExtendedLocationTypes

Enumeration

Der Typ von extendedLocation.

Wert	Beschreibung
CustomLocation	Benutzerdefinierter erweiterter Standorttyp

InboundNATRuleProtocol

Enumeration

Protokoll für eingehende NAT-Regeln

Wert	Beschreibung
Tcp	TCP – nur TCP – nur TCP-Verkehr für Lastausgleich
Udp	UDP – Nur UDP-Verkehr für Lastausgleich

InboundRule

Objekt

Die Definition der eingehenden Regel-Ressourcen.

Name	Typ	Beschreibung
extendedLocation	ExtendedLocation	Die extendedLocation der Ressource.
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties	InboundRuleProperties	Die ressourcenspezifischen Eigenschaften für diese Ressource.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

InboundRuleListResult

Objekt

Die Antwort einer InboundRule-Listenoperation.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite der Elemente
value	InboundRule[]	Die InboundRule-Elemente auf dieser Seite

InboundRuleProperties

Objekt

Eigenschaften der eingehenden Regel – erweitert InboundNATRuleProperties um zusätzliche Statusverfolgung

Name	Typ	Beschreibung
backendIPConfiguration	IPConfigurationArmReference	IP-Konfiguration für das Ziel-Backend.
backendPort	integer (int32)	Backend-Port für die eingehende Regel
frontendPort	integer (int32)	Frontend-Port für die eingehende Regel
protocol	InboundNATRuleProtocol	Protokoll für die NAT-Regel
provisioningState	ProvisioningStateEnum	Bereitstellungszustand der eingehenden Regel
publicIPAddress	PublicIPAddressArmReference	Öffentliche IP-Adresse für diese NAT-Regel
status	InboundRuleStatus	Der beobachtete Zustand der Inbound Rule

InboundRuleStatus

Objekt

Der beobachtete Zustand der eingehenden Regel

Name	Typ	Beschreibung
errorCode	string	InboundRule-Bereitstellungsfehlercode
errorMessage	string	Beschreibende Fehlermeldung
provisioningStatus	InboundRuleStatusProvisioningStatus	Status der Bereitstellung von InboundRule

InboundRuleStatusProvisioningStatus

Objekt

Bereitstellungsstatus der Inbound Rule

Name	Typ	Beschreibung
operationId	string	Die ID der auf der eingehenden Regel durchgeführten Operation
status	Status	Der Status der auf der eingehenden Regel ausgeführten Operation [Erfolgreich, Fehlgeschlagen, InLaufen]

IPConfigurationArmReference

Objekt

Die Azure Resource ID einer IPConfiguration-Ressource

Name	Typ	Beschreibung
resourceId	string (arm-id)	Die Azure Resource ID einer IPConfiguration-Ressource

ProvisioningStateEnum

Enumeration

Bereitstellungsstatus der Ressource.

Wert	Beschreibung
Succeeded	Die Bereitstellung ist erfolgreich.
Failed	Fehler bei der Bereitstellung
InProgress	Die Bereitstellung wird ausgeführt.
Accepted	Die Bereitstellung wurde akzeptiert.
Deleting	Das Löschen der Ressource wird ausgeführt.
Canceled	Die Bereitstellung wurde abgebrochen.

PublicIPAddressArmReference

Objekt

Die Azure Resource ID einer öffentlichen IP-Ressource

Name	Typ	Beschreibung
resourceId	string (arm-id)	Die Azure Resource ID einer öffentlichen IP-Ressource

Status

Enumeration

Der Status des Vorgangs, der für die Ressource ausgeführt wurde [Erfolgreich, Fehlgeschlagen, InProgress]

Wert	Beschreibung
Succeeded	Vorgang erfolgreich
Failed	Fehler beim Vorgang.
InProgress	Der Vorgang wird ausgeführt.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Inbound Rules - List By Nat Gateway

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ListInboundRulesByNatGateway

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationTypes

InboundNATRuleProtocol

InboundRule

InboundRuleListResult

InboundRuleProperties

InboundRuleStatus

InboundRuleStatusProvisioningStatus

IPConfigurationArmReference

ProvisioningStateEnum

PublicIPAddressArmReference

Status

systemData