Inbound Rules - List By Nat Gateway

Служба:: Azure Stack HCI

Версия API:: 2026-04-01-preview

Перечисляет все входящие правила в указанном шлюзе NAT. Используйте свойство nextLink в ответе, чтобы получить следующую страницу входящих правил.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
natGatewayName	path	True	string pattern: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$	Название национального портала
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	InboundRuleListResult	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	Выдача себя за свою учетную запись пользователя

Примеры

ListInboundRulesByNatGateway

Образец запроса

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

Пример ответа

Код состояния:: 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"
          }
        }
      }
    }
  ]
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
ExtendedLocation	Сложный тип расширенного расположения.
ExtendedLocationTypes	Тип extendedLocation.
InboundNATRuleProtocol	Протокол для входящих правил NAT
InboundRule	Определение ресурса входящего правила.
InboundRuleListResult	Ответ операции списка InboundRule.
InboundRuleProperties	Свойства входящих правил — расширяют InboundNATRuleProperties с дополнительным отслеживанием статуса
InboundRuleStatus	Наблюдаемое состояние входящего правила
InboundRuleStatusProvisioningStatus	Статус предоставления входящего правила
IPConfigurationArmReference	Azure Resource ID ресурса IPConfiguration
ProvisioningStateEnum	Состояние подготовки ресурса.
PublicIPAddressArmReference	Azure Resource ID публичного IP-ресурса
Status	Состояние операции, выполняемой на ресурсе [Выполнено, сбой, InProgress]
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Объект

Ошибка управления ресурсами дополнительная информация.

Имя	Тип	Описание
info	object	Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Детали ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ExtendedLocation

Объект

Сложный тип расширенного расположения.

Имя	Тип	Описание
name	string	Имя расширенного расположения.
type	ExtendedLocationTypes	Тип расширенного расположения.

ExtendedLocationTypes

Перечисление

Тип extendedLocation.

Значение	Описание
CustomLocation	Тип настраиваемого расширенного расположения

InboundNATRuleProtocol

Перечисление

Протокол для входящих правил NAT

Значение	Описание
Tcp	TCP — TCP-трафик только баланс нагрузки
Udp	UDP — трафик только с балансом нагрузки

InboundRule

Объект

Определение ресурса входящего правила.

Имя	Тип	Описание
extendedLocation	ExtendedLocation	Расширенное размещение ресурса.
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса.
properties	InboundRuleProperties	Свойства, относящиеся к ресурсу, для этого ресурса.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

InboundRuleListResult

Объект

Ответ операции списка InboundRule.

Имя	Тип	Описание
nextLink	string (uri)	Ссылка на следующую страницу элементов
value	InboundRule[]	Пункты InboundRule на этой странице

InboundRuleProperties

Объект

Свойства входящих правил — расширяют InboundNATRuleProperties с дополнительным отслеживанием статуса

Имя	Тип	Описание
backendIPConfiguration	IPConfigurationArmReference	Конфигурация IP для целевой бэкенда.
backendPort	integer (int32)	backend порт для входящего правила
frontendPort	integer (int32)	Фронтенд-порт для входящего правила
protocol	InboundNATRuleProtocol	Протокол для правила NAT
provisioningState	ProvisioningStateEnum	Состояние обеспечения входящего правила
publicIPAddress	PublicIPAddressArmReference	Публичный IP-адрес для этого правила NAT
status	InboundRuleStatus	Наблюдаемое состояние входящего правила

InboundRuleStatus

Объект

Наблюдаемое состояние входящего правила

Имя	Тип	Описание
errorCode	string	Код ошибки provisioning InboundRule
errorMessage	string	Описательное сообщение об ошибке
provisioningStatus	InboundRuleStatusProvisioningStatus	Статус provisioning InboundRule

InboundRuleStatusProvisioningStatus

Объект

Статус предоставления входящего правила

Имя	Тип	Описание
operationId	string	ID операции, выполняемой на входящем правиле
status	Status	Статус операции, выполненной по правилу входящего сообщения [Успешно, Невыполнено, Невыполнено]

IPConfigurationArmReference

Объект

Azure Resource ID ресурса IPConfiguration

Имя	Тип	Описание
resourceId	string (arm-id)	Azure Resource ID ресурса IPConfiguration

ProvisioningStateEnum

Перечисление

Состояние подготовки ресурса.

Значение	Описание
Succeeded	Подготовка выполнена успешно
Failed	Сбой подготовки
InProgress	Подготовка выполняется
Accepted	Подготовка была принята
Deleting	Выполняется удаление ресурса
Canceled	Подготовка отменена

PublicIPAddressArmReference

Объект

Azure Resource ID публичного IP-ресурса

Имя	Тип	Описание
resourceId	string (arm-id)	Azure Resource ID публичного IP-ресурса

Status

Перечисление

Состояние операции, выполняемой на ресурсе [Выполнено, сбой, InProgress]

Значение	Описание
Succeeded	Операция выполнена успешно
Failed	Сбой операции
InProgress	Операция выполняется

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Inbound Rules - List By Nat Gateway

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

ListInboundRulesByNatGateway

Образец запроса

Пример ответа

Определения

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationTypes

InboundNATRuleProtocol

InboundRule

InboundRuleListResult

InboundRuleProperties

InboundRuleStatus

InboundRuleStatusProvisioningStatus

IPConfigurationArmReference

ProvisioningStateEnum

PublicIPAddressArmReference

Status

systemData