Obtient la passerelle nat spécifiée dans un groupe de ressources spécifié.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}?api-version=2023-09-01
With optional parameters:
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}?api-version=2023-09-01&$expand={$expand}
Paramètres URI
Nom |
Dans |
Obligatoire |
Type |
Description |
natGatewayName
|
path |
True
|
string
|
Nom de la passerelle nat.
|
resourceGroupName
|
path |
True
|
string
|
Nom du groupe de ressources.
|
subscriptionId
|
path |
True
|
string
|
Informations d’identification d’abonnement qui identifient de façon unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
|
api-version
|
query |
True
|
string
|
Version d’API client.
|
$expand
|
query |
|
string
|
Développe les ressources référencées.
|
Réponses
Nom |
Type |
Description |
200 OK
|
NatGateway
|
La demande a réussi. L’opération retourne la ressource NatGateway résultante.
|
Other Status Codes
|
CloudError
|
Réponse d’erreur décrivant la raison de l’échec de l’opération.
|
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom |
Description |
user_impersonation
|
Emprunter l’identité de votre compte d’utilisateur
|
Exemples
Get nat gateway
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway?api-version=2023-09-01
/**
* Samples for NatGateways GetByResourceGroup.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NatGatewayGet.json
*/
/**
* Sample code: Get nat gateway.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getNatGateway(com.azure.resourcemanager.AzureResourceManager azure) {
azure.networks().manager().serviceClient().getNatGateways().getByResourceGroupWithResponse("rg1",
"test-natGateway", null, com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-network
# USAGE
python nat_gateway_get.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = NetworkManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.nat_gateways.get(
resource_group_name="rg1",
nat_gateway_name="test-natGateway",
)
print(response)
# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NatGatewayGet.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armnetwork_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NatGatewayGet.json
func ExampleNatGatewaysClient_Get() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNatGatewaysClient().Get(ctx, "rg1", "test-natGateway", &armnetwork.NatGatewaysClientGetOptions{Expand: nil})
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NatGateway = armnetwork.NatGateway{
// Name: to.Ptr("test-natGateway"),
// Type: to.Ptr("Microsoft.Network/natGateways"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway"),
// Location: to.Ptr("westus"),
// Properties: &armnetwork.NatGatewayPropertiesFormat{
// IdleTimeoutInMinutes: to.Ptr[int32](5),
// ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
// PublicIPAddresses: []*armnetwork.SubResource{
// {
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"),
// }},
// PublicIPPrefixes: []*armnetwork.SubResource{
// {
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"),
// }},
// Subnets: []*armnetwork.SubResource{
// {
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"),
// }},
// },
// SKU: &armnetwork.NatGatewaySKU{
// Name: to.Ptr(armnetwork.NatGatewaySKUNameStandard),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets the specified nat gateway in a specified resource group.
*
* @summary Gets the specified nat gateway in a specified resource group.
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NatGatewayGet.json
*/
async function getNatGateway() {
const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
const natGatewayName = "test-natGateway";
const credential = new DefaultAzureCredential();
const client = new NetworkManagementClient(credential, subscriptionId);
const result = await client.natGateways.get(resourceGroupName, natGatewayName);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;
// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NatGatewayGet.json
// this example is just showing the usage of "NatGateways_Get" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this NatGatewayResource created on azure
// for more information of creating NatGatewayResource, please refer to the document of NatGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string natGatewayName = "test-natGateway";
ResourceIdentifier natGatewayResourceId = NatGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, natGatewayName);
NatGatewayResource natGateway = client.GetNatGatewayResource(natGatewayResourceId);
// invoke the operation
NatGatewayResource result = await natGateway.GetAsync();
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
NatGatewayData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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"
}
Définitions
CloudError
Réponse d’erreur du service.
CloudErrorBody
Réponse d’erreur du service.
Nom |
Type |
Description |
code
|
string
|
Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
|
details
|
CloudErrorBody[]
|
Liste de détails supplémentaires sur l’erreur.
|
message
|
string
|
Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
|
target
|
string
|
Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.
|
NatGateway
Ressource Nat Gateway.
Nom |
Type |
Description |
etag
|
string
|
Chaîne unique en lecture seule qui change chaque fois que la ressource est mise à jour.
|
id
|
string
|
ID de la ressource
|
location
|
string
|
Emplacement de la ressource.
|
name
|
string
|
Nom de la ressource.
|
properties.idleTimeoutInMinutes
|
integer
|
Délai d’inactivité de la passerelle nat.
|
properties.provisioningState
|
ProvisioningState
|
État d’approvisionnement de la ressource de passerelle NAT.
|
properties.publicIpAddresses
|
SubResource[]
|
Tableau d’adresses IP publiques associées à la ressource de passerelle nat.
|
properties.publicIpPrefixes
|
SubResource[]
|
Tableau de préfixes ip publics associés à la ressource de passerelle nat.
|
properties.resourceGuid
|
string
|
Propriété GUID de ressource de la ressource de passerelle NAT.
|
properties.subnets
|
SubResource[]
|
Tableau de références aux sous-réseaux à l’aide de cette ressource de passerelle nat.
|
sku
|
NatGatewaySku
|
Référence SKU de la passerelle nat.
|
tags
|
object
|
Balises de ressource.
|
type
|
string
|
Type de ressource.
|
zones
|
string[]
|
Liste des zones de disponibilité indiquant la zone dans laquelle Nat Gateway doit être déployé.
|
NatGatewaySku
Référence SKU de la passerelle nat.
NatGatewaySkuName
Nom de la référence SKU Nat Gateway.
Nom |
Type |
Description |
Standard
|
string
|
|
ProvisioningState
État d’approvisionnement actuel.
Nom |
Type |
Description |
Deleting
|
string
|
|
Failed
|
string
|
|
Succeeded
|
string
|
|
Updating
|
string
|
|
SubResource
Référence à une autre sous-ressource.
Nom |
Type |
Description |
id
|
string
|
ID de la ressource
|