Inbound Rules - List By Nat Gateway

Service:: Azure Stack HCI

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

Liste toutes les règles entrantes dans la passerelle NAT spécifiée. Utilisez la propriété nextLink dans la réponse pour obtenir la page suivante des règles entrantes.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
natGatewayName	path	True	string pattern: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$	Nom de la porte d’entrée naturelle
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	InboundRuleListResult	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

ListInboundRulesByNatGateway

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
          }
        }
      }
    }
  ]
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ExtendedLocation	Type complexe de l’emplacement étendu.
ExtendedLocationTypes	Type de extendedLocation.
InboundNATRuleProtocol	Protocole pour les règles NAT entrantes
InboundRule	La définition de la ressource de la règle entrante.
InboundRuleListResult	La réponse d’une opération de liste InboundRule.
InboundRuleProperties	Propriétés de règles entrantes - étend InboundNATRuleProperties avec un suivi de statut supplémentaire
InboundRuleStatus	L’état observé de la règle d’entrée
InboundRuleStatusProvisioningStatus	Statut de provisionnement de la règle d’entrée
IPConfigurationArmReference	L’ID de ressource Azure d’une ressource IPConfiguration
ProvisioningStateEnum	État d’approvisionnement de la ressource.
PublicIPAddressArmReference	L’ID de ressource Azure d’une ressource IP publique
Status	État de l’opération effectuée sur la ressource [Réussite, Échec, InProgress]
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ExtendedLocation

Objet

Type complexe de l’emplacement étendu.

Nom	Type	Description
name	string	Nom de l’emplacement étendu.
type	ExtendedLocationTypes	Type de l’emplacement étendu.

ExtendedLocationTypes

Énumération

Type de extendedLocation.

Valeur	Description
CustomLocation	Type d’emplacement étendu personnalisé

InboundNATRuleProtocol

Énumération

Protocole pour les règles NAT entrantes

Valeur	Description
Tcp	TCP - trafic TCP uniquement pour équilibrage de charge
Udp	Flux UDP - balancement de charge uniquement le trafic UDP

InboundRule

Objet

La définition de la ressource de la règle entrante.

Nom	Type	Description
extendedLocation	ExtendedLocation	ExtendedLocation de la ressource.
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties	InboundRuleProperties	Propriétés spécifiques à la ressource pour cette ressource.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

InboundRuleListResult

Objet

La réponse d’une opération de liste InboundRule.

Nom	Type	Description
nextLink	string (uri)	Lien vers la page suivante des éléments
value	InboundRule[]	Les éléments InboundRule sur cette page

InboundRuleProperties

Objet

Propriétés de règles entrantes - étend InboundNATRuleProperties avec un suivi de statut supplémentaire

Nom	Type	Description
backendIPConfiguration	IPConfigurationArmReference	Configuration IP pour le backend cible.
backendPort	integer (int32)	Port backend pour la règle d’entrée
frontendPort	integer (int32)	Port frontend pour la règle d’entrée
protocol	InboundNATRuleProtocol	Protocole pour la règle NAT
provisioningState	ProvisioningStateEnum	État de provisionnement de la règle d’entrée
publicIPAddress	PublicIPAddressArmReference	Adresse IP publique pour cette règle NAT
status	InboundRuleStatus	L’état observé de la règle d’entrée

InboundRuleStatus

Objet

L’état observé de la règle d’entrée

Nom	Type	Description
errorCode	string	Code d’erreur de provisionnement InboundRule
errorMessage	string	Message d’erreur descriptif
provisioningStatus	InboundRuleStatusProvisioningStatus	Statut de provisionnement InboundRule

InboundRuleStatusProvisioningStatus

Objet

Statut de provisionnement de la règle d’entrée

Nom	Type	Description
operationId	string	L’ID de l’opération effectuée sur la règle d’entrée
status	Status	Statut de l’opération effectuée sur la règle d’entrée [Réussi, Échoué, En cours]

IPConfigurationArmReference

Objet

L’ID de ressource Azure d’une ressource IPConfiguration

Nom	Type	Description
resourceId	string (arm-id)	L’ID de ressource Azure d’une ressource IPConfiguration

ProvisioningStateEnum

Énumération

État d’approvisionnement de la ressource.

Valeur	Description
Succeeded	L’approvisionnement a réussi
Failed	L’approvisionnement a échoué
InProgress	L’approvisionnement est en cours
Accepted	L’approvisionnement a été accepté
Deleting	La suppression de la ressource est en cours
Canceled	L’approvisionnement a été annulé

PublicIPAddressArmReference

Objet

L’ID de ressource Azure d’une ressource IP publique

Nom	Type	Description
resourceId	string (arm-id)	L’ID de ressource Azure d’une ressource IP publique

Status

Énumération

État de l’opération effectuée sur la ressource [Réussite, Échec, InProgress]

Valeur	Description
Succeeded	Opération réussie
Failed	Échec de l’opération
InProgress	L’opération est en cours

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Inbound Rules - List By Nat Gateway

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

ListInboundRulesByNatGateway

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationTypes

InboundNATRuleProtocol

InboundRule

InboundRuleListResult

InboundRuleProperties

InboundRuleStatus

InboundRuleStatusProvisioningStatus

IPConfigurationArmReference

ProvisioningStateEnum

PublicIPAddressArmReference

Status

systemData