Nat Gateways - Get

Возвращает указанный шлюз NAT в указанной группе ресурсов.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}?api-version=2022-01-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}?api-version=2022-01-01&$expand={$expand}

Параметры URI

Name In Required Type Description
natGatewayName
path True
  • string

Имя шлюза NAT.

resourceGroupName
path True
  • string

Имя группы ресурсов.

subscriptionId
path True
  • string

Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписку. Идентификатор подписки формирует часть URI для каждого вызова службы.

api-version
query True
  • string

Версия API клиента.

$expand
query
  • string

Развертывает ресурсы, на которые ссылается ссылка.

Ответы

Name Type Description
200 OK

Запрос выполнен успешно. Операция возвращает полученный ресурс NatGateway.

Other Status Codes

Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation олицетворения учетной записи пользователя

Примеры

Get nat gateway

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway?api-version=2022-01-01

Sample Response

{
  "name": "test-natGateway",
  "sku": {
    "name": "Standard"
  },
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway",
  "location": "westus",
  "properties": {
    "idleTimeoutInMinutes": 5,
    "provisioningState": "Succeeded",
    "publicIpAddresses": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"
      }
    ],
    "publicIpPrefixes": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"
      }
    ],
    "subnets": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"
      }
    ]
  },
  "type": "Microsoft.Network/natGateways"
}

Определения

CloudError

Ответ об ошибке службы.

CloudErrorBody

Ответ об ошибке службы.

NatGateway

Ресурс шлюза Nat.

NatGatewaySku

Номер SKU шлюза NAT.

NatGatewaySkuName

Имя SKU шлюза Nat.

ProvisioningState

Текущее состояние подготовки.

SubResource

Ссылка на другой подресурс.

CloudError

Ответ об ошибке службы.

Name Type Description
error

Текст ошибки облака.

CloudErrorBody

Ответ об ошибке службы.

Name Type Description
code
  • string

Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.

details

Список дополнительных сведений об ошибке.

message
  • string

Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.

target
  • string

Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

NatGateway

Ресурс шлюза Nat.

Name Type Description
etag
  • string

Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса.

id
  • string

Идентификатор ресурса.

location
  • string

Расположение ресурса.

name
  • string

Имя ресурса.

properties.idleTimeoutInMinutes
  • integer

Время ожидания простоя шлюза NAT.

properties.provisioningState

Состояние подготовки ресурса шлюза NAT.

properties.publicIpAddresses

Массив общедоступных IP-адресов, связанных с ресурсом шлюза NAT.

properties.publicIpPrefixes

Массив префиксов общедоступных IP-адресов, связанных с ресурсом шлюза NAT.

properties.resourceGuid
  • string

Свойство GUID ресурса ресурса шлюза NAT.

properties.subnets

Массив ссылок на подсети, использующие этот ресурс шлюза NAT.

sku

SKU шлюза nat.

tags
  • object

Теги ресурсов.

type
  • string

Тип ресурса.

zones
  • string[]

Список зон доступности, обозначающих зону, в которой должен быть развернут шлюз Nat.

NatGatewaySku

Номер SKU шлюза NAT.

Name Type Description
name

Имя SKU шлюза Nat.

NatGatewaySkuName

Имя SKU шлюза Nat.

Name Type Description
Standard
  • string

ProvisioningState

Текущее состояние подготовки.

Name Type Description
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

SubResource

Ссылка на другой подресурс.

Name Type Description
id
  • string

Идентификатор ресурса.