Inbound Rules - List By Nat Gateway

Serviço:: Azure Stack HCI

Versão da API:: 2026-04-01-preview

Lista todas as regras de entrada no gateway NAT especificado. Use a propriedade nextLink na resposta para obter a página seguinte de regras de entrada.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
natGatewayName	path	True	string pattern: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$	Nome do portal natural
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	InboundRuleListResult	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ListInboundRulesByNatGateway

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
          }
        }
      }
    }
  ]
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ExtendedLocation	O tipo complexo do local estendido.
ExtendedLocationTypes	O tipo de extendedLocation.
InboundNATRuleProtocol	Protocolo para regras NAT de entrada
InboundRule	A definição de recurso de regras de entrada.
InboundRuleListResult	A resposta de uma operação de lista InboundRule.
InboundRuleProperties	Propriedades da regra de entrada - estende o InboundNATRuleProperties com rastreamento adicional de estado
InboundRuleStatus	O estado observado da regra de entrada
InboundRuleStatusProvisioningStatus	Estado de aprovisionamento da Regra de Entrada
IPConfigurationArmReference	O ID de recurso Azure de um recurso IPConfiguration
ProvisioningStateEnum	Estado de provisionamento do recurso.
PublicIPAddressArmReference	O ID de recurso Azure de um recurso IP Público
Status	O status da operação executada no recurso [Succeeded, Failed, InProgress]
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExtendedLocation

Object

O tipo complexo do local estendido.

Name	Tipo	Description
name	string	O nome do local estendido.
type	ExtendedLocationTypes	O tipo de localização ampliada.

ExtendedLocationTypes

Enumeração

O tipo de extendedLocation.

Valor	Description
CustomLocation	Tipo de local estendido personalizado

InboundNATRuleProtocol

Enumeração

Protocolo para regras NAT de entrada

Valor	Description
Tcp	TCP - tráfego TCP apenas para balanceamento de carga
Udp	Udp - apenas tráfego UDP com balanceamento de carga

InboundRule

Object

A definição de recurso de regras de entrada.

Name	Tipo	Description
extendedLocation	ExtendedLocation	O extendedLocation do recurso.
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties	InboundRuleProperties	As propriedades específicas do recurso para este recurso.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

InboundRuleListResult

Object

A resposta de uma operação de lista InboundRule.

Name	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	InboundRule[]	Os itens do InboundRule nesta página

InboundRuleProperties

Object

Propriedades da regra de entrada - estende o InboundNATRuleProperties com rastreamento adicional de estado

Name	Tipo	Description
backendIPConfiguration	IPConfigurationArmReference	Configuração de IP para o backend de destino.
backendPort	integer (int32)	Port backend para a regra de entrada
frontendPort	integer (int32)	Porta frontend para a regra de entrada
protocol	InboundNATRuleProtocol	Protocolo para a regra NAT
provisioningState	ProvisioningStateEnum	Estado de provisionamento da regra de entrada
publicIPAddress	PublicIPAddressArmReference	Endereço IP Público para esta regra NAT
status	InboundRuleStatus	O estado observado da Regra de Entrada

InboundRuleStatus

Object

O estado observado da regra de entrada

Name	Tipo	Description
errorCode	string	Código de erro de provisionamento InboundRule
errorMessage	string	Mensagem de erro descritiva
provisioningStatus	InboundRuleStatusProvisioningStatus	Estado de provisionamento InboundRule

InboundRuleStatusProvisioningStatus

Object

Estado de aprovisionamento da Regra de Entrada

Name	Tipo	Description
operationId	string	O ID da operação realizada na regra de entrada
status	Status	O estado da operação realizada na regra de entrada [Bem-sucedido, Falhado, Em Progresso]

IPConfigurationArmReference

Object

O ID de recurso Azure de um recurso IPConfiguration

Name	Tipo	Description
resourceId	string (arm-id)	O ID de recurso Azure de um recurso IPConfiguration

ProvisioningStateEnum

Enumeração

Estado de provisionamento do recurso.

Valor	Description
Succeeded	O provisionamento foi bem-sucedido
Failed	O provisionamento falhou
InProgress	O provisionamento está em andamento
Accepted	O provisionamento foi aceito
Deleting	A supressão do recurso está em curso
Canceled	O provisionamento foi cancelado

PublicIPAddressArmReference

Object

O ID de recurso Azure de um recurso IP Público

Name	Tipo	Description
resourceId	string (arm-id)	O ID de recurso Azure de um recurso IP Público

Status

Enumeração

O status da operação executada no recurso [Succeeded, Failed, InProgress]

Valor	Description
Succeeded	Operação bem sucedida
Failed	Falha na operação
InProgress	Operação está em curso

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via

Inbound Rules - List By Nat Gateway

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ListInboundRulesByNatGateway

Pedido de amostra

Resposta da amostra

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationTypes

InboundNATRuleProtocol

InboundRule

InboundRuleListResult

InboundRuleProperties

InboundRuleStatus

InboundRuleStatusProvisioningStatus

IPConfigurationArmReference

ProvisioningStateEnum

PublicIPAddressArmReference

Status

systemData