Compartilhar via


Virtual Network Gateways - Get

Gets the specified virtual network gateway by resource group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}?api-version=2024-01-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

virtualNetworkGatewayName
path True

string

The name of the virtual network gateway.

api-version
query True

string

Client API version.

Responses

Name Type Description
200 OK

VirtualNetworkGateway

Request successful. The operation returns a VirtualNetworkGateway resource.

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

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 impersonate your user account

Examples

GetVirtualNetworkGateway
GetVirtualNetworkScalableGateway

GetVirtualNetworkGateway

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw?api-version=2024-01-01

Sample response

{
  "name": "vpngw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "type": "Microsoft.Network/virtualNetworkGateways",
  "location": "centralus",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "ipConfigurations": [
      {
        "name": "gwipconfig1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
          },
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
          }
        }
      }
    ],
    "natRules": [
      {
        "name": "natRule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "10.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "50.0.0.0/24"
            }
          ]
        }
      },
      {
        "name": "natRule2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "IngressSnat",
          "internalMappings": [
            {
              "addressSpace": "20.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "30.0.0.0/24"
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": false,
    "sku": {
      "name": "VpnGw1",
      "tier": "VpnGw1",
      "capacity": 0
    },
    "gatewayType": "Vpn",
    "vpnType": "RouteBased",
    "vpnGatewayGeneration": "None",
    "enableBgp": false,
    "enablePrivateIpAddress": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "vpnClientConfiguration": {
      "vpnClientProtocols": [
        "OpenVPN"
      ],
      "vpnClientRootCertificates": [],
      "vpnClientRevokedCertificates": [],
      "radiusServers": [
        {
          "radiusServerAddress": "10.1.0.0",
          "radiusServerScore": 20
        }
      ]
    },
    "bgpSettings": {
      "asn": 65514,
      "bgpPeeringAddress": "10.0.1.30",
      "peerWeight": 0,
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1",
          "defaultBgpIpAddresses": [
            "10.3.1.254"
          ],
          "customBgpIpAddresses": [
            "169.254.21.10"
          ],
          "tunnelIpAddresses": [
            "52.161.10.135"
          ]
        }
      ]
    },
    "customRoutes": {
      "addressPrefixes": [
        "101.168.0.6/32"
      ]
    },
    "allowVirtualWanTraffic": false,
    "allowRemoteVnetTraffic": false
  }
}

GetVirtualNetworkScalableGateway

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw?api-version=2024-01-01

Sample response

{
  "name": "ergw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "type": "Microsoft.Network/virtualNetworkGateways",
  "location": "centralus",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "ipConfigurations": [
      {
        "name": "gwipconfig1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Static",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
          },
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
          }
        }
      }
    ],
    "natRules": [
      {
        "name": "natRule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "10.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "50.0.0.0/24"
            }
          ]
        }
      },
      {
        "name": "natRule2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "IngressSnat",
          "internalMappings": [
            {
              "addressSpace": "20.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "30.0.0.0/24"
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": false,
    "sku": {
      "name": "ErGwScale",
      "tier": "ErGwScale",
      "capacity": 2
    },
    "autoScaleConfiguration": {
      "bounds": {
        "min": 2,
        "max": 3
      }
    },
    "gatewayType": "ExpressRoute",
    "vpnType": "PolicyBased",
    "vpnGatewayGeneration": "None",
    "enableBgp": false,
    "enablePrivateIpAddress": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "vpnClientConfiguration": null,
    "bgpSettings": null,
    "customRoutes": null,
    "allowVirtualWanTraffic": false,
    "allowRemoteVnetTraffic": false
  }
}

Definitions

Name Description
AddressSpace

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

adminState

Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet

BgpSettings

BGP settings details.

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

DhGroup

The DH Groups used in IKE Phase 1 for initial SA.

ExtendedLocation

ExtendedLocation complex type.

ExtendedLocationTypes

The type of the extended location.

IkeEncryption

The IKE encryption algorithm (IKE phase 2).

IkeIntegrity

The IKE integrity algorithm (IKE phase 2).

IPAllocationMethod

IP address allocation method.

IPConfigurationBgpPeeringAddress

Properties of IPConfigurationBgpPeeringAddress.

IpsecEncryption

The IPSec encryption algorithm (IKE phase 1).

IpsecIntegrity

The IPSec integrity algorithm (IKE phase 1).

IpsecPolicy

An IPSec Policy configuration for a virtual network gateway connection.

ManagedServiceIdentity

Identity for the resource.

PfsGroup

The Pfs Groups used in IKE Phase 2 for new child SA.

ProvisioningState

The current provisioning state.

RadiusServer

Radius Server Settings.

ResourceIdentityType

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.

SubResource

Reference to another subresource.

UserAssignedIdentities

The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

VirtualNetworkGateway

A common class for general resource information.

VirtualNetworkGatewayAutoScaleBounds
VirtualNetworkGatewayAutoScaleConfiguration

Virtual Network Gateway Autoscale Configuration details

VirtualNetworkGatewayIPConfiguration

IP configuration for virtual network gateway.

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRule Resource.

VirtualNetworkGatewayPolicyGroup

Parameters for VirtualNetworkGatewayPolicyGroup.

VirtualNetworkGatewayPolicyGroupMember

Vpn Client Connection configuration PolicyGroup member

VirtualNetworkGatewaySku

VirtualNetworkGatewaySku details.

VirtualNetworkGatewaySkuName

Gateway SKU name.

VirtualNetworkGatewaySkuTier

Gateway SKU tier.

VirtualNetworkGatewayType

The type of this virtual network gateway.

VngClientConnectionConfiguration

A vpn client connection configuration for client connection configuration.

VpnAuthenticationType

VPN authentication types for the virtual network gateway..

VpnClientConfiguration

VpnClientConfiguration for P2S client.

VpnClientProtocol

VpnClientProtocols for Virtual network gateway.

VpnClientRevokedCertificate

VPN client revoked certificate of virtual network gateway.

VpnClientRootCertificate

VPN client root certificate of virtual network gateway.

VpnGatewayGeneration

The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.

VpnNatRuleMapping

Vpn NatRule mapping.

VpnNatRuleMode

The Source NAT direction of a VPN NAT.

VpnNatRuleType

The type of NAT rule for VPN NAT.

VpnPolicyMemberAttributeType

The Vpn Policy member attribute type.

VpnType

The type of this virtual network gateway.

AddressSpace

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

Name Type Description
addressPrefixes

string[]

A list of address blocks reserved for this virtual network in CIDR notation.

adminState

Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet

Name Type Description
Disabled

string

Enabled

string

BgpSettings

BGP settings details.

Name Type Description
asn

integer

The BGP speaker's ASN.

bgpPeeringAddress

string

The BGP peering address and BGP identifier of this BGP speaker.

bgpPeeringAddresses

IPConfigurationBgpPeeringAddress[]

BGP peering address with IP configuration ID for virtual network gateway.

peerWeight

integer

The weight added to routes learned from this BGP speaker.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

DhGroup

The DH Groups used in IKE Phase 1 for initial SA.

Name Type Description
DHGroup1

string

DHGroup14

string

DHGroup2

string

DHGroup2048

string

DHGroup24

string

ECP256

string

ECP384

string

None

string

ExtendedLocation

ExtendedLocation complex type.

Name Type Description
name

string

The name of the extended location.

type

ExtendedLocationTypes

The type of the extended location.

ExtendedLocationTypes

The type of the extended location.

Name Type Description
EdgeZone

string

IkeEncryption

The IKE encryption algorithm (IKE phase 2).

Name Type Description
AES128

string

AES192

string

AES256

string

DES

string

DES3

string

GCMAES128

string

GCMAES256

string

IkeIntegrity

The IKE integrity algorithm (IKE phase 2).

Name Type Description
GCMAES128

string

GCMAES256

string

MD5

string

SHA1

string

SHA256

string

SHA384

string

IPAllocationMethod

IP address allocation method.

Name Type Description
Dynamic

string

Static

string

IPConfigurationBgpPeeringAddress

Properties of IPConfigurationBgpPeeringAddress.

Name Type Description
customBgpIpAddresses

string[]

The list of custom BGP peering addresses which belong to IP configuration.

defaultBgpIpAddresses

string[]

The list of default BGP peering addresses which belong to IP configuration.

ipconfigurationId

string

The ID of IP configuration which belongs to gateway.

tunnelIpAddresses

string[]

The list of tunnel public IP addresses which belong to IP configuration.

IpsecEncryption

The IPSec encryption algorithm (IKE phase 1).

Name Type Description
AES128

string

AES192

string

AES256

string

DES

string

DES3

string

GCMAES128

string

GCMAES192

string

GCMAES256

string

None

string

IpsecIntegrity

The IPSec integrity algorithm (IKE phase 1).

Name Type Description
GCMAES128

string

GCMAES192

string

GCMAES256

string

MD5

string

SHA1

string

SHA256

string

IpsecPolicy

An IPSec Policy configuration for a virtual network gateway connection.

Name Type Description
dhGroup

DhGroup

The DH Group used in IKE Phase 1 for initial SA.

ikeEncryption

IkeEncryption

The IKE encryption algorithm (IKE phase 2).

ikeIntegrity

IkeIntegrity

The IKE integrity algorithm (IKE phase 2).

ipsecEncryption

IpsecEncryption

The IPSec encryption algorithm (IKE phase 1).

ipsecIntegrity

IpsecIntegrity

The IPSec integrity algorithm (IKE phase 1).

pfsGroup

PfsGroup

The Pfs Group used in IKE Phase 2 for new child SA.

saDataSizeKilobytes

integer

The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.

saLifeTimeSeconds

integer

The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.

ManagedServiceIdentity

Identity for the resource.

Name Type Description
principalId

string

The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

tenantId

string

The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.

type

ResourceIdentityType

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.

userAssignedIdentities

UserAssignedIdentities

The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

PfsGroup

The Pfs Groups used in IKE Phase 2 for new child SA.

Name Type Description
ECP256

string

ECP384

string

None

string

PFS1

string

PFS14

string

PFS2

string

PFS2048

string

PFS24

string

PFSMM

string

ProvisioningState

The current provisioning state.

Name Type Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

RadiusServer

Radius Server Settings.

Name Type Description
radiusServerAddress

string

The address of this radius server.

radiusServerScore

integer

The initial score assigned to this radius server.

radiusServerSecret

string

The secret used for this radius server.

ResourceIdentityType

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.

Name Type Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

SubResource

Reference to another subresource.

Name Type Description
id

string

Resource ID.

UserAssignedIdentities

The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name Type Description

VirtualNetworkGateway

A common class for general resource information.

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

extendedLocation

ExtendedLocation

The extended location of type local virtual network gateway.

id

string

Resource ID.

identity

ManagedServiceIdentity

The identity of the virtual network gateway, if configured.

location

string

Resource location.

name

string

Resource name.

properties.activeActive

boolean

ActiveActive flag.

properties.adminState

adminState

Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet

properties.allowRemoteVnetTraffic

boolean

Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN.

properties.allowVirtualWanTraffic

boolean

Configures this gateway to accept traffic from remote Virtual WAN networks.

properties.autoScaleConfiguration

VirtualNetworkGatewayAutoScaleConfiguration

Autoscale configuration for virutal network gateway

properties.bgpSettings

BgpSettings

Virtual network gateway's BGP speaker settings.

properties.customRoutes

AddressSpace

The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.

properties.disableIPSecReplayProtection

boolean

disableIPSecReplayProtection flag.

properties.enableBgp

boolean

Whether BGP is enabled for this virtual network gateway or not.

properties.enableBgpRouteTranslationForNat

boolean

EnableBgpRouteTranslationForNat flag.

properties.enableDnsForwarding

boolean

Whether dns forwarding is enabled or not.

properties.enablePrivateIpAddress

boolean

Whether private IP needs to be enabled on this gateway for connections or not.

properties.gatewayDefaultSite

SubResource

The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.

properties.gatewayType

VirtualNetworkGatewayType

The type of this virtual network gateway.

properties.inboundDnsForwardingEndpoint

string

The IP address allocated by the gateway to which dns requests can be sent.

properties.ipConfigurations

VirtualNetworkGatewayIPConfiguration[]

IP configurations for virtual network gateway.

properties.natRules

VirtualNetworkGatewayNatRule[]

NatRules for virtual network gateway.

properties.provisioningState

ProvisioningState

The provisioning state of the virtual network gateway resource.

properties.resourceGuid

string

The resource GUID property of the virtual network gateway resource.

properties.sku

VirtualNetworkGatewaySku

The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.

properties.vNetExtendedLocationResourceId

string

Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.

properties.virtualNetworkGatewayPolicyGroups

VirtualNetworkGatewayPolicyGroup[]

The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.

properties.vpnClientConfiguration

VpnClientConfiguration

The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.

properties.vpnGatewayGeneration

VpnGatewayGeneration

The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.

properties.vpnType

VpnType

The type of this virtual network gateway.

tags

object

Resource tags.

type

string

Resource type.

VirtualNetworkGatewayAutoScaleBounds

Name Type Description
max

integer

Maximum Scale Units for Autoscale configuration

min

integer

Minimum scale Units for Autoscale configuration

VirtualNetworkGatewayAutoScaleConfiguration

Virtual Network Gateway Autoscale Configuration details

Name Type Description
bounds

VirtualNetworkGatewayAutoScaleBounds

The bounds of the autoscale configuration

VirtualNetworkGatewayIPConfiguration

IP configuration for virtual network gateway.

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

id

string

Resource ID.

name

string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.privateIPAddress

string

Private IP Address for this gateway.

properties.privateIPAllocationMethod

IPAllocationMethod

The private IP address allocation method.

properties.provisioningState

ProvisioningState

The provisioning state of the virtual network gateway IP configuration resource.

properties.publicIPAddress

SubResource

The reference to the public IP resource.

properties.subnet

SubResource

The reference to the subnet resource.

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRule Resource.

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

id

string

Resource ID.

name

string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.externalMappings

VpnNatRuleMapping[]

The private IP address external mapping for NAT.

properties.internalMappings

VpnNatRuleMapping[]

The private IP address internal mapping for NAT.

properties.ipConfigurationId

string

The IP Configuration ID this NAT rule applies to.

properties.mode

VpnNatRuleMode

The Source NAT direction of a VPN NAT.

properties.provisioningState

ProvisioningState

The provisioning state of the NAT Rule resource.

properties.type

VpnNatRuleType

The type of NAT rule for VPN NAT.

type

string

Resource type.

VirtualNetworkGatewayPolicyGroup

Parameters for VirtualNetworkGatewayPolicyGroup.

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

id

string

Resource ID.

name

string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.isDefault

boolean

Shows if this is a Default VirtualNetworkGatewayPolicyGroup or not.

properties.policyMembers

VirtualNetworkGatewayPolicyGroupMember[]

Multiple PolicyMembers for VirtualNetworkGatewayPolicyGroup.

properties.priority

integer

Priority for VirtualNetworkGatewayPolicyGroup.

properties.provisioningState

ProvisioningState

The provisioning state of the VirtualNetworkGatewayPolicyGroup resource.

properties.vngClientConnectionConfigurations

SubResource[]

List of references to vngClientConnectionConfigurations.

VirtualNetworkGatewayPolicyGroupMember

Vpn Client Connection configuration PolicyGroup member

Name Type Description
attributeType

VpnPolicyMemberAttributeType

The Vpn Policy member attribute type.

attributeValue

string

The value of Attribute used for this VirtualNetworkGatewayPolicyGroupMember.

name

string

Name of the VirtualNetworkGatewayPolicyGroupMember.

VirtualNetworkGatewaySku

VirtualNetworkGatewaySku details.

Name Type Description
capacity

integer

The capacity.

name

VirtualNetworkGatewaySkuName

Gateway SKU name.

tier

VirtualNetworkGatewaySkuTier

Gateway SKU tier.

VirtualNetworkGatewaySkuName

Gateway SKU name.

Name Type Description
Basic

string

ErGw1AZ

string

ErGw2AZ

string

ErGw3AZ

string

ErGwScale

string

HighPerformance

string

Standard

string

UltraPerformance

string

VpnGw1

string

VpnGw1AZ

string

VpnGw2

string

VpnGw2AZ

string

VpnGw3

string

VpnGw3AZ

string

VpnGw4

string

VpnGw4AZ

string

VpnGw5

string

VpnGw5AZ

string

VirtualNetworkGatewaySkuTier

Gateway SKU tier.

Name Type Description
Basic

string

ErGw1AZ

string

ErGw2AZ

string

ErGw3AZ

string

ErGwScale

string

HighPerformance

string

Standard

string

UltraPerformance

string

VpnGw1

string

VpnGw1AZ

string

VpnGw2

string

VpnGw2AZ

string

VpnGw3

string

VpnGw3AZ

string

VpnGw4

string

VpnGw4AZ

string

VpnGw5

string

VpnGw5AZ

string

VirtualNetworkGatewayType

The type of this virtual network gateway.

Name Type Description
ExpressRoute

string

LocalGateway

string

Vpn

string

VngClientConnectionConfiguration

A vpn client connection configuration for client connection configuration.

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

id

string

Resource ID.

name

string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.provisioningState

ProvisioningState

The provisioning state of the VngClientConnectionConfiguration resource.

properties.virtualNetworkGatewayPolicyGroups

SubResource[]

List of references to virtualNetworkGatewayPolicyGroups

properties.vpnClientAddressPool

AddressSpace

The reference to the address space resource which represents Address space for P2S VpnClient.

VpnAuthenticationType

VPN authentication types for the virtual network gateway..

Name Type Description
AAD

string

Certificate

string

Radius

string

VpnClientConfiguration

VpnClientConfiguration for P2S client.

Name Type Description
aadAudience

string

The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.

aadIssuer

string

The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.

aadTenant

string

The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.

radiusServerAddress

string

The radius server address property of the VirtualNetworkGateway resource for vpn client connection.

radiusServerSecret

string

The radius secret property of the VirtualNetworkGateway resource for vpn client connection.

radiusServers

RadiusServer[]

The radiusServers property for multiple radius server configuration.

vngClientConnectionConfigurations

VngClientConnectionConfiguration[]

per ip address pool connection policy for virtual network gateway P2S client.

vpnAuthenticationTypes

VpnAuthenticationType[]

VPN authentication types for the virtual network gateway..

vpnClientAddressPool

AddressSpace

The reference to the address space resource which represents Address space for P2S VpnClient.

vpnClientIpsecPolicies

IpsecPolicy[]

VpnClientIpsecPolicies for virtual network gateway P2S client.

vpnClientProtocols

VpnClientProtocol[]

VpnClientProtocols for Virtual network gateway.

vpnClientRevokedCertificates

VpnClientRevokedCertificate[]

VpnClientRevokedCertificate for Virtual network gateway.

vpnClientRootCertificates

VpnClientRootCertificate[]

VpnClientRootCertificate for virtual network gateway.

VpnClientProtocol

VpnClientProtocols for Virtual network gateway.

Name Type Description
IkeV2

string

OpenVPN

string

SSTP

string

VpnClientRevokedCertificate

VPN client revoked certificate of virtual network gateway.

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

id

string

Resource ID.

name

string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.provisioningState

ProvisioningState

The provisioning state of the VPN client revoked certificate resource.

properties.thumbprint

string

The revoked VPN client certificate thumbprint.

VpnClientRootCertificate

VPN client root certificate of virtual network gateway.

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

id

string

Resource ID.

name

string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.provisioningState

ProvisioningState

The provisioning state of the VPN client root certificate resource.

properties.publicCertData

string

The certificate public data.

VpnGatewayGeneration

The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.

Name Type Description
Generation1

string

Generation2

string

None

string

VpnNatRuleMapping

Vpn NatRule mapping.

Name Type Description
addressSpace

string

Address space for Vpn NatRule mapping.

portRange

string

Port range for Vpn NatRule mapping.

VpnNatRuleMode

The Source NAT direction of a VPN NAT.

Name Type Description
EgressSnat

string

IngressSnat

string

VpnNatRuleType

The type of NAT rule for VPN NAT.

Name Type Description
Dynamic

string

Static

string

VpnPolicyMemberAttributeType

The Vpn Policy member attribute type.

Name Type Description
AADGroupId

string

CertificateGroupId

string

RadiusAzureGroupId

string

VpnType

The type of this virtual network gateway.

Name Type Description
PolicyBased

string

RouteBased

string