Nat Gateways - Get
指定したリソース グループ内の指定した nat ゲートウェイを取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}?api-version=2025-05-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}?api-version=2025-05-01&$expand={$expand}
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
nat
|
path | True |
string |
nat ゲートウェイの名前。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
リソース グループの名前。 名前の大文字と小文字は区別されません。 |
|
subscription
|
path | True |
string (uuid) |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
|
$expand
|
query |
string |
参照先のリソースを展開します。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
Azureの運用は無事に完了しました。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
| Get nat gateway |
| Get nat gateway with service gateway |
| Get nat gateway with StandardV2 Sku |
Get nat gateway
要求のサンプル
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway?api-version=2025-05-01
応答のサンプル
{
"name": "test-natGateway",
"type": "Microsoft.Network/natGateways",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway",
"location": "westus",
"properties": {
"idleTimeoutInMinutes": 5,
"provisioningState": "Succeeded",
"publicIpAddresses": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"
}
],
"publicIpPrefixes": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"
}
],
"subnets": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"
}
]
},
"sku": {
"name": "Standard"
}
}
Get nat gateway with service gateway
要求のサンプル
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway?api-version=2025-05-01
応答のサンプル
{
"name": "test-natGateway",
"type": "Microsoft.Network/natGateways",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway",
"location": "westus",
"properties": {
"idleTimeoutInMinutes": 5,
"provisioningState": "Succeeded",
"publicIpAddresses": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"
}
],
"publicIpPrefixes": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"
}
],
"serviceGateway": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/serviceGateways/SG1"
}
},
"sku": {
"name": "Standard"
}
}
Get nat gateway with StandardV2 Sku
要求のサンプル
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway?api-version=2025-05-01
応答のサンプル
{
"name": "test-natGateway",
"type": "Microsoft.Network/natGateways",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway",
"location": "westus",
"properties": {
"idleTimeoutInMinutes": 5,
"provisioningState": "Succeeded",
"publicIpAddresses": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"
}
],
"publicIpAddressesV6": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress2"
}
],
"publicIpPrefixes": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"
}
],
"publicIpPrefixesV6": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix2"
}
],
"sourceVirtualNetwork": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet"
},
"subnets": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"
}
]
},
"sku": {
"name": "StandardV2"
}
}
定義
| 名前 | 説明 |
|---|---|
|
Cloud |
サービスからのエラー応答。 |
|
Cloud |
サービスからのエラー応答。 |
|
Nat |
Nat Gateway リソース。 |
|
Nat |
NAT ゲートウェイの SKU。 |
|
Nat |
Nat Gateway SKU の名前。 |
|
Provisioning |
リソースのプロビジョニング状態。 |
|
Sub |
別のサブリソースへの参照。 |
CloudError
サービスからのエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
クラウド エラー本文。 |
CloudErrorBody
サービスからのエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。 |
| details |
エラーに関する追加の詳細のリスト。 |
|
| message |
string |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
| target |
string |
特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。 |
NatGateway
Nat Gateway リソース。
| 名前 | 型 | 説明 |
|---|---|---|
| etag |
string |
リソースが更新されるたびに変更される一意の読み取り専用文字列。 |
| id |
string |
リソース ID。 |
| location |
string |
リソースの場所。 |
| name |
string |
リソース名。 |
| properties.idleTimeoutInMinutes |
integer (int32) |
nat ゲートウェイのアイドル タイムアウト。 |
| properties.provisioningState |
NAT ゲートウェイ リソースのプロビジョニング状態。 |
|
| properties.publicIpAddresses |
nat ゲートウェイ リソースに関連付けられたパブリック IP アドレス V4 の配列。 |
|
| properties.publicIpAddressesV6 |
nat ゲートウェイ リソースに関連付けられたパブリック IP アドレス V6 の配列。 |
|
| properties.publicIpPrefixes |
nat ゲートウェイ リソースに関連付けられたパブリック IP プレフィックス V4 の配列。 |
|
| properties.publicIpPrefixesV6 |
nat ゲートウェイ リソースに関連付けられたパブリック IP プレフィックス V6 の配列。 |
|
| properties.resourceGuid |
string |
NAT ゲートウェイ リソースのリソース GUID プロパティ。 |
| properties.serviceGateway |
既存のサービスゲートウェイへの言及。 |
|
| properties.sourceVirtualNetwork |
この nat ゲートウェイ リソースを使用したソース仮想ネットワークへの参照。 |
|
| properties.subnets |
このnatゲートウェイ・リソースを使用するサブネットへの参照の配列。 |
|
| sku |
NAT ゲートウェイ SKU。 |
|
| tags |
object |
リソース タグ。 |
| type |
string |
リソースの種類。 |
| zones |
string[] |
Nat Gateway をデプロイする必要があるゾーンを示す可用性ゾーンの一覧。 |
NatGatewaySku
NAT ゲートウェイの SKU。
| 名前 | 型 | 説明 |
|---|---|---|
| name |
Nat Gateway SKU の名前。 |
NatGatewaySkuName
Nat Gateway SKU の名前。
| 値 | 説明 |
|---|---|
| Standard |
Standard |
| StandardV2 |
StandardV2 |
ProvisioningState
リソースのプロビジョニング状態。
| 値 | 説明 |
|---|---|
| Failed |
失敗 |
| Succeeded |
成功しました |
| Canceled |
取り消し済み |
| Creating |
作成 |
| Updating |
更新中 |
| Deleting |
削除中 |
SubResource
別のサブリソースへの参照。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string |
リソース ID。 |