Nat Gateways - Get

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=2020-11-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}?api-version=2020-11-01&$expand={$expand}

Paramètres URI

Name In Required 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 des ressources référencées.

Réponses

Name Type Description
200 OK

Demande réussie. L’opération retourne la ressource NatGateway résultante.

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Azure Active Directory le Flow OAuth2.

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

Scopes

Name 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=2020-11-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"
}

Définitions

CloudError

Réponse d’erreur du service.

CloudErrorBody

Réponse d’erreur du service.

NatGateway

Ressource de passerelle NAT.

NatGatewaySku

Référence SKU de la passerelle NAT.

NatGatewaySkuName

Nom de la référence SKU de la passerelle NAT.

ProvisioningState

État d’approvisionnement actuel.

SubResource

Référence à une autre sous-ressource.

CloudError

Réponse d’erreur du service.

Name Type Description
error

Corps de l’erreur Cloud.

CloudErrorBody

Réponse d’erreur du service.

Name Type Description
code
  • string

Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.

details

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é dans erreur.

NatGateway

Ressource de passerelle NAT.

Name Type Description
etag
  • string

Chaîne en lecture seule unique 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

État d’approvisionnement de la ressource de passerelle NAT.

properties.publicIpAddresses

Tableau d’adresses IP publiques associées à la ressource de passerelle NAT.

properties.publicIpPrefixes

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

Tableau de références aux sous-réseaux à l’aide de cette ressource de passerelle NAT.

sku

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 la passerelle NAT doit être déployée.

NatGatewaySku

Référence SKU de la passerelle NAT.

Name Type Description
name

Nom de la référence SKU de la passerelle NAT.

NatGatewaySkuName

Nom de la référence SKU de la passerelle NAT.

Name Type Description
Standard
  • string

ProvisioningState

État d’approvisionnement actuel.

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

SubResource

Référence à une autre sous-ressource.

Name Type Description
id
  • string

ID de la ressource