Docs Packages
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. network
  5. getVirtualNetworkGateway
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getVirtualNetworkGateway

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Gets the specified virtual network gateway by resource group. API Version: 2020-11-01.

    Using getVirtualNetworkGateway

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVirtualNetworkGateway(args: GetVirtualNetworkGatewayArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkGatewayResult>
function getVirtualNetworkGatewayOutput(args: GetVirtualNetworkGatewayOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkGatewayResult>
    def get_virtual_network_gateway(resource_group_name: Optional[str] = None,
                                virtual_network_gateway_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkGatewayResult
def get_virtual_network_gateway_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                virtual_network_gateway_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkGatewayResult]
    func LookupVirtualNetworkGateway(ctx *Context, args *LookupVirtualNetworkGatewayArgs, opts ...InvokeOption) (*LookupVirtualNetworkGatewayResult, error)
func LookupVirtualNetworkGatewayOutput(ctx *Context, args *LookupVirtualNetworkGatewayOutputArgs, opts ...InvokeOption) LookupVirtualNetworkGatewayResultOutput

    > Note: This function is named LookupVirtualNetworkGateway in the Go SDK.

    public static class GetVirtualNetworkGateway 
{
    public static Task<GetVirtualNetworkGatewayResult> InvokeAsync(GetVirtualNetworkGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualNetworkGatewayResult> Invoke(GetVirtualNetworkGatewayInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVirtualNetworkGatewayResult> getVirtualNetworkGateway(GetVirtualNetworkGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:network:getVirtualNetworkGateway
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group.
    VirtualNetworkGatewayName string
    The name of the virtual network gateway.
    ResourceGroupName string
    The name of the resource group.
    VirtualNetworkGatewayName string
    The name of the virtual network gateway.
    resourceGroupName String
    The name of the resource group.
    virtualNetworkGatewayName String
    The name of the virtual network gateway.
    resourceGroupName string
    The name of the resource group.
    virtualNetworkGatewayName string
    The name of the virtual network gateway.
    resource_group_name str
    The name of the resource group.
    virtual_network_gateway_name str
    The name of the virtual network gateway.
    resourceGroupName String
    The name of the resource group.
    virtualNetworkGatewayName String
    The name of the virtual network gateway.

    getVirtualNetworkGateway Result

    The following output properties are available:

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    InboundDnsForwardingEndpoint string
    The IP address allocated by the gateway to which dns requests can be sent.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the virtual network gateway resource.
    ResourceGuid string
    The resource GUID property of the virtual network gateway resource.
    Type string
    Resource type.
    ActiveActive bool
    ActiveActive flag.
    BgpSettings Pulumi.AzureNative.Network.Outputs.BgpSettingsResponse
    Virtual network gateway's BGP speaker settings.
    CustomRoutes Pulumi.AzureNative.Network.Outputs.AddressSpaceResponse
    The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
    EnableBgp bool
    Whether BGP is enabled for this virtual network gateway or not.
    EnableDnsForwarding bool
    Whether dns forwarding is enabled or not.
    EnablePrivateIpAddress bool
    Whether private IP needs to be enabled on this gateway for connections or not.
    ExtendedLocation Pulumi.AzureNative.Network.Outputs.ExtendedLocationResponse
    The extended location of type local virtual network gateway.
    GatewayDefaultSite Pulumi.AzureNative.Network.Outputs.SubResourceResponse
    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.
    GatewayType string
    The type of this virtual network gateway.
    Id string
    Resource ID.
    IpConfigurations List<Pulumi.AzureNative.Network.Outputs.VirtualNetworkGatewayIPConfigurationResponse>
    IP configurations for virtual network gateway.
    Location string
    Resource location.
    Sku Pulumi.AzureNative.Network.Outputs.VirtualNetworkGatewaySkuResponse
    The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
    Tags Dictionary<string, string>
    Resource tags.
    VNetExtendedLocationResourceId string
    Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.
    VpnClientConfiguration Pulumi.AzureNative.Network.Outputs.VpnClientConfigurationResponse
    The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
    VpnGatewayGeneration string
    The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.
    VpnType string
    The type of this virtual network gateway.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    InboundDnsForwardingEndpoint string
    The IP address allocated by the gateway to which dns requests can be sent.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the virtual network gateway resource.
    ResourceGuid string
    The resource GUID property of the virtual network gateway resource.
    Type string
    Resource type.
    ActiveActive bool
    ActiveActive flag.
    BgpSettings BgpSettingsResponse
    Virtual network gateway's BGP speaker settings.
    CustomRoutes AddressSpaceResponse
    The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
    EnableBgp bool
    Whether BGP is enabled for this virtual network gateway or not.
    EnableDnsForwarding bool
    Whether dns forwarding is enabled or not.
    EnablePrivateIpAddress bool
    Whether private IP needs to be enabled on this gateway for connections or not.
    ExtendedLocation ExtendedLocationResponse
    The extended location of type local virtual network gateway.
    GatewayDefaultSite SubResourceResponse
    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.
    GatewayType string
    The type of this virtual network gateway.
    Id string
    Resource ID.
    IpConfigurations []VirtualNetworkGatewayIPConfigurationResponse
    IP configurations for virtual network gateway.
    Location string
    Resource location.
    Sku VirtualNetworkGatewaySkuResponse
    The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
    Tags map[string]string
    Resource tags.
    VNetExtendedLocationResourceId string
    Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.
    VpnClientConfiguration VpnClientConfigurationResponse
    The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
    VpnGatewayGeneration string
    The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.
    VpnType string
    The type of this virtual network gateway.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    inboundDnsForwardingEndpoint String
    The IP address allocated by the gateway to which dns requests can be sent.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the virtual network gateway resource.
    resourceGuid String
    The resource GUID property of the virtual network gateway resource.
    type String
    Resource type.
    activeActive Boolean
    ActiveActive flag.
    bgpSettings BgpSettingsResponse
    Virtual network gateway's BGP speaker settings.
    customRoutes AddressSpaceResponse
    The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
    enableBgp Boolean
    Whether BGP is enabled for this virtual network gateway or not.
    enableDnsForwarding Boolean
    Whether dns forwarding is enabled or not.
    enablePrivateIpAddress Boolean
    Whether private IP needs to be enabled on this gateway for connections or not.
    extendedLocation ExtendedLocationResponse
    The extended location of type local virtual network gateway.
    gatewayDefaultSite SubResourceResponse
    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.
    gatewayType String
    The type of this virtual network gateway.
    id String
    Resource ID.
    ipConfigurations List<VirtualNetworkGatewayIPConfigurationResponse>
    IP configurations for virtual network gateway.
    location String
    Resource location.
    sku VirtualNetworkGatewaySkuResponse
    The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
    tags Map<String,String>
    Resource tags.
    vNetExtendedLocationResourceId String
    Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.
    vpnClientConfiguration VpnClientConfigurationResponse
    The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
    vpnGatewayGeneration String
    The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.
    vpnType String
    The type of this virtual network gateway.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    inboundDnsForwardingEndpoint string
    The IP address allocated by the gateway to which dns requests can be sent.
    name string
    Resource name.
    provisioningState string
    The provisioning state of the virtual network gateway resource.
    resourceGuid string
    The resource GUID property of the virtual network gateway resource.
    type string
    Resource type.
    activeActive boolean
    ActiveActive flag.
    bgpSettings BgpSettingsResponse
    Virtual network gateway's BGP speaker settings.
    customRoutes AddressSpaceResponse
    The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
    enableBgp boolean
    Whether BGP is enabled for this virtual network gateway or not.
    enableDnsForwarding boolean
    Whether dns forwarding is enabled or not.
    enablePrivateIpAddress boolean
    Whether private IP needs to be enabled on this gateway for connections or not.
    extendedLocation ExtendedLocationResponse
    The extended location of type local virtual network gateway.
    gatewayDefaultSite SubResourceResponse
    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.
    gatewayType string
    The type of this virtual network gateway.
    id string
    Resource ID.
    ipConfigurations VirtualNetworkGatewayIPConfigurationResponse[]
    IP configurations for virtual network gateway.
    location string
    Resource location.
    sku VirtualNetworkGatewaySkuResponse
    The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
    tags {[key: string]: string}
    Resource tags.
    vNetExtendedLocationResourceId string
    Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.
    vpnClientConfiguration VpnClientConfigurationResponse
    The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
    vpnGatewayGeneration string
    The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.
    vpnType string
    The type of this virtual network gateway.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    inbound_dns_forwarding_endpoint str
    The IP address allocated by the gateway to which dns requests can be sent.
    name str
    Resource name.
    provisioning_state str
    The provisioning state of the virtual network gateway resource.
    resource_guid str
    The resource GUID property of the virtual network gateway resource.
    type str
    Resource type.
    active_active bool
    ActiveActive flag.
    bgp_settings BgpSettingsResponse
    Virtual network gateway's BGP speaker settings.
    custom_routes AddressSpaceResponse
    The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
    enable_bgp bool
    Whether BGP is enabled for this virtual network gateway or not.
    enable_dns_forwarding bool
    Whether dns forwarding is enabled or not.
    enable_private_ip_address bool
    Whether private IP needs to be enabled on this gateway for connections or not.
    extended_location ExtendedLocationResponse
    The extended location of type local virtual network gateway.
    gateway_default_site SubResourceResponse
    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.
    gateway_type str
    The type of this virtual network gateway.
    id str
    Resource ID.
    ip_configurations Sequence[VirtualNetworkGatewayIPConfigurationResponse]
    IP configurations for virtual network gateway.
    location str
    Resource location.
    sku VirtualNetworkGatewaySkuResponse
    The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
    tags Mapping[str, str]
    Resource tags.
    v_net_extended_location_resource_id str
    Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.
    vpn_client_configuration VpnClientConfigurationResponse
    The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
    vpn_gateway_generation str
    The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.
    vpn_type str
    The type of this virtual network gateway.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    inboundDnsForwardingEndpoint String
    The IP address allocated by the gateway to which dns requests can be sent.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the virtual network gateway resource.
    resourceGuid String
    The resource GUID property of the virtual network gateway resource.
    type String
    Resource type.
    activeActive Boolean
    ActiveActive flag.
    bgpSettings Property Map
    Virtual network gateway's BGP speaker settings.
    customRoutes Property Map
    The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
    enableBgp Boolean
    Whether BGP is enabled for this virtual network gateway or not.
    enableDnsForwarding Boolean
    Whether dns forwarding is enabled or not.
    enablePrivateIpAddress Boolean
    Whether private IP needs to be enabled on this gateway for connections or not.
    extendedLocation Property Map
    The extended location of type local virtual network gateway.
    gatewayDefaultSite Property Map
    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.
    gatewayType String
    The type of this virtual network gateway.
    id String
    Resource ID.
    ipConfigurations List<Property Map>
    IP configurations for virtual network gateway.
    location String
    Resource location.
    sku Property Map
    The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
    tags Map<String>
    Resource tags.
    vNetExtendedLocationResourceId String
    Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.
    vpnClientConfiguration Property Map
    The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
    vpnGatewayGeneration String
    The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.
    vpnType String
    The type of this virtual network gateway.

    Supporting Types

    AddressSpaceResponse

    AddressPrefixes List<string>
    A list of address blocks reserved for this virtual network in CIDR notation.
    AddressPrefixes []string
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes List<String>
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes string[]
    A list of address blocks reserved for this virtual network in CIDR notation.
    address_prefixes Sequence[str]
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes List<String>
    A list of address blocks reserved for this virtual network in CIDR notation.

    BgpSettingsResponse

    Asn double
    The BGP speaker's ASN.
    BgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    BgpPeeringAddresses List<Pulumi.AzureNative.Network.Inputs.IPConfigurationBgpPeeringAddressResponse>
    BGP peering address with IP configuration ID for virtual network gateway.
    PeerWeight int
    The weight added to routes learned from this BGP speaker.
    Asn float64
    The BGP speaker's ASN.
    BgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    BgpPeeringAddresses []IPConfigurationBgpPeeringAddressResponse
    BGP peering address with IP configuration ID for virtual network gateway.
    PeerWeight int
    The weight added to routes learned from this BGP speaker.
    asn Double
    The BGP speaker's ASN.
    bgpPeeringAddress String
    The BGP peering address and BGP identifier of this BGP speaker.
    bgpPeeringAddresses List<IPConfigurationBgpPeeringAddressResponse>
    BGP peering address with IP configuration ID for virtual network gateway.
    peerWeight Integer
    The weight added to routes learned from this BGP speaker.
    asn number
    The BGP speaker's ASN.
    bgpPeeringAddress string
    The BGP peering address and BGP identifier of this BGP speaker.
    bgpPeeringAddresses IPConfigurationBgpPeeringAddressResponse[]
    BGP peering address with IP configuration ID for virtual network gateway.
    peerWeight number
    The weight added to routes learned from this BGP speaker.
    asn float
    The BGP speaker's ASN.
    bgp_peering_address str
    The BGP peering address and BGP identifier of this BGP speaker.
    bgp_peering_addresses Sequence[IPConfigurationBgpPeeringAddressResponse]
    BGP peering address with IP configuration ID for virtual network gateway.
    peer_weight int
    The weight added to routes learned from this BGP speaker.
    asn Number
    The BGP speaker's ASN.
    bgpPeeringAddress String
    The BGP peering address and BGP identifier of this BGP speaker.
    bgpPeeringAddresses List<Property Map>
    BGP peering address with IP configuration ID for virtual network gateway.
    peerWeight Number
    The weight added to routes learned from this BGP speaker.

    ExtendedLocationResponse

    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.
    name string
    The name of the extended location.
    type string
    The type of the extended location.
    name str
    The name of the extended location.
    type str
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.

    IPConfigurationBgpPeeringAddressResponse

    DefaultBgpIpAddresses List<string>
    The list of default BGP peering addresses which belong to IP configuration.
    TunnelIpAddresses List<string>
    The list of tunnel public IP addresses which belong to IP configuration.
    CustomBgpIpAddresses List<string>
    The list of custom BGP peering addresses which belong to IP configuration.
    IpconfigurationId string
    The ID of IP configuration which belongs to gateway.
    DefaultBgpIpAddresses []string
    The list of default BGP peering addresses which belong to IP configuration.
    TunnelIpAddresses []string
    The list of tunnel public IP addresses which belong to IP configuration.
    CustomBgpIpAddresses []string
    The list of custom BGP peering addresses which belong to IP configuration.
    IpconfigurationId string
    The ID of IP configuration which belongs to gateway.
    defaultBgpIpAddresses List<String>
    The list of default BGP peering addresses which belong to IP configuration.
    tunnelIpAddresses List<String>
    The list of tunnel public IP addresses which belong to IP configuration.
    customBgpIpAddresses List<String>
    The list of custom BGP peering addresses which belong to IP configuration.
    ipconfigurationId String
    The ID of IP configuration which belongs to gateway.
    defaultBgpIpAddresses string[]
    The list of default BGP peering addresses which belong to IP configuration.
    tunnelIpAddresses string[]
    The list of tunnel public IP addresses which belong to IP configuration.
    customBgpIpAddresses string[]
    The list of custom BGP peering addresses which belong to IP configuration.
    ipconfigurationId string
    The ID of IP configuration which belongs to gateway.
    default_bgp_ip_addresses Sequence[str]
    The list of default BGP peering addresses which belong to IP configuration.
    tunnel_ip_addresses Sequence[str]
    The list of tunnel public IP addresses which belong to IP configuration.
    custom_bgp_ip_addresses Sequence[str]
    The list of custom BGP peering addresses which belong to IP configuration.
    ipconfiguration_id str
    The ID of IP configuration which belongs to gateway.
    defaultBgpIpAddresses List<String>
    The list of default BGP peering addresses which belong to IP configuration.
    tunnelIpAddresses List<String>
    The list of tunnel public IP addresses which belong to IP configuration.
    customBgpIpAddresses List<String>
    The list of custom BGP peering addresses which belong to IP configuration.
    ipconfigurationId String
    The ID of IP configuration which belongs to gateway.

    IpsecPolicyResponse

    DhGroup string
    The DH Group used in IKE Phase 1 for initial SA.
    IkeEncryption string
    The IKE encryption algorithm (IKE phase 2).
    IkeIntegrity string
    The IKE integrity algorithm (IKE phase 2).
    IpsecEncryption string
    The IPSec encryption algorithm (IKE phase 1).
    IpsecIntegrity string
    The IPSec integrity algorithm (IKE phase 1).
    PfsGroup string
    The Pfs Group used in IKE Phase 2 for new child SA.
    SaDataSizeKilobytes int
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
    SaLifeTimeSeconds int
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
    DhGroup string
    The DH Group used in IKE Phase 1 for initial SA.
    IkeEncryption string
    The IKE encryption algorithm (IKE phase 2).
    IkeIntegrity string
    The IKE integrity algorithm (IKE phase 2).
    IpsecEncryption string
    The IPSec encryption algorithm (IKE phase 1).
    IpsecIntegrity string
    The IPSec integrity algorithm (IKE phase 1).
    PfsGroup string
    The Pfs Group used in IKE Phase 2 for new child SA.
    SaDataSizeKilobytes int
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
    SaLifeTimeSeconds int
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
    dhGroup String
    The DH Group used in IKE Phase 1 for initial SA.
    ikeEncryption String
    The IKE encryption algorithm (IKE phase 2).
    ikeIntegrity String
    The IKE integrity algorithm (IKE phase 2).
    ipsecEncryption String
    The IPSec encryption algorithm (IKE phase 1).
    ipsecIntegrity String
    The IPSec integrity algorithm (IKE phase 1).
    pfsGroup String
    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.
    dhGroup string
    The DH Group used in IKE Phase 1 for initial SA.
    ikeEncryption string
    The IKE encryption algorithm (IKE phase 2).
    ikeIntegrity string
    The IKE integrity algorithm (IKE phase 2).
    ipsecEncryption string
    The IPSec encryption algorithm (IKE phase 1).
    ipsecIntegrity string
    The IPSec integrity algorithm (IKE phase 1).
    pfsGroup string
    The Pfs Group used in IKE Phase 2 for new child SA.
    saDataSizeKilobytes number
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
    saLifeTimeSeconds number
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
    dh_group str
    The DH Group used in IKE Phase 1 for initial SA.
    ike_encryption str
    The IKE encryption algorithm (IKE phase 2).
    ike_integrity str
    The IKE integrity algorithm (IKE phase 2).
    ipsec_encryption str
    The IPSec encryption algorithm (IKE phase 1).
    ipsec_integrity str
    The IPSec integrity algorithm (IKE phase 1).
    pfs_group str
    The Pfs Group used in IKE Phase 2 for new child SA.
    sa_data_size_kilobytes int
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
    sa_life_time_seconds int
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
    dhGroup String
    The DH Group used in IKE Phase 1 for initial SA.
    ikeEncryption String
    The IKE encryption algorithm (IKE phase 2).
    ikeIntegrity String
    The IKE integrity algorithm (IKE phase 2).
    ipsecEncryption String
    The IPSec encryption algorithm (IKE phase 1).
    ipsecIntegrity String
    The IPSec integrity algorithm (IKE phase 1).
    pfsGroup String
    The Pfs Group used in IKE Phase 2 for new child SA.
    saDataSizeKilobytes Number
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
    saLifeTimeSeconds Number
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.

    RadiusServerResponse

    RadiusServerAddress string
    The address of this radius server.
    RadiusServerScore double
    The initial score assigned to this radius server.
    RadiusServerSecret string
    The secret used for this radius server.
    RadiusServerAddress string
    The address of this radius server.
    RadiusServerScore float64
    The initial score assigned to this radius server.
    RadiusServerSecret string
    The secret used for this radius server.
    radiusServerAddress String
    The address of this radius server.
    radiusServerScore Double
    The initial score assigned to this radius server.
    radiusServerSecret String
    The secret used for this radius server.
    radiusServerAddress string
    The address of this radius server.
    radiusServerScore number
    The initial score assigned to this radius server.
    radiusServerSecret string
    The secret used for this radius server.
    radius_server_address str
    The address of this radius server.
    radius_server_score float
    The initial score assigned to this radius server.
    radius_server_secret str
    The secret used for this radius server.
    radiusServerAddress String
    The address of this radius server.
    radiusServerScore Number
    The initial score assigned to this radius server.
    radiusServerSecret String
    The secret used for this radius server.

    SubResourceResponse

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    VirtualNetworkGatewayIPConfigurationResponse

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    PrivateIPAddress string
    Private IP Address for this gateway.
    ProvisioningState string
    The provisioning state of the virtual network gateway IP configuration resource.
    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.
    PrivateIPAllocationMethod string
    The private IP address allocation method.
    PublicIPAddress Pulumi.AzureNative.Network.Inputs.SubResourceResponse
    The reference to the public IP resource.
    Subnet Pulumi.AzureNative.Network.Inputs.SubResourceResponse
    The reference to the subnet resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    PrivateIPAddress string
    Private IP Address for this gateway.
    ProvisioningState string
    The provisioning state of the virtual network gateway IP configuration resource.
    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.
    PrivateIPAllocationMethod string
    The private IP address allocation method.
    PublicIPAddress SubResourceResponse
    The reference to the public IP resource.
    Subnet SubResourceResponse
    The reference to the subnet resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    privateIPAddress String
    Private IP Address for this gateway.
    provisioningState String
    The provisioning state of the virtual network gateway IP configuration resource.
    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.
    privateIPAllocationMethod String
    The private IP address allocation method.
    publicIPAddress SubResourceResponse
    The reference to the public IP resource.
    subnet SubResourceResponse
    The reference to the subnet resource.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    privateIPAddress string
    Private IP Address for this gateway.
    provisioningState string
    The provisioning state of the virtual network gateway IP configuration resource.
    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.
    privateIPAllocationMethod string
    The private IP address allocation method.
    publicIPAddress SubResourceResponse
    The reference to the public IP resource.
    subnet SubResourceResponse
    The reference to the subnet resource.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    private_ip_address str
    Private IP Address for this gateway.
    provisioning_state str
    The provisioning state of the virtual network gateway IP configuration resource.
    id str
    Resource ID.
    name str
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    private_ip_allocation_method str
    The private IP address allocation method.
    public_ip_address SubResourceResponse
    The reference to the public IP resource.
    subnet SubResourceResponse
    The reference to the subnet resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    privateIPAddress String
    Private IP Address for this gateway.
    provisioningState String
    The provisioning state of the virtual network gateway IP configuration resource.
    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.
    privateIPAllocationMethod String
    The private IP address allocation method.
    publicIPAddress Property Map
    The reference to the public IP resource.
    subnet Property Map
    The reference to the subnet resource.

    VirtualNetworkGatewaySkuResponse

    Capacity int
    The capacity.
    Name string
    Gateway SKU name.
    Tier string
    Gateway SKU tier.
    Capacity int
    The capacity.
    Name string
    Gateway SKU name.
    Tier string
    Gateway SKU tier.
    capacity Integer
    The capacity.
    name String
    Gateway SKU name.
    tier String
    Gateway SKU tier.
    capacity number
    The capacity.
    name string
    Gateway SKU name.
    tier string
    Gateway SKU tier.
    capacity int
    The capacity.
    name str
    Gateway SKU name.
    tier str
    Gateway SKU tier.
    capacity Number
    The capacity.
    name String
    Gateway SKU name.
    tier String
    Gateway SKU tier.

    VpnClientConfigurationResponse

    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 List<Pulumi.AzureNative.Network.Inputs.RadiusServerResponse>
    The radiusServers property for multiple radius server configuration.
    VpnAuthenticationTypes List<string>
    VPN authentication types for the virtual network gateway..
    VpnClientAddressPool Pulumi.AzureNative.Network.Inputs.AddressSpaceResponse
    The reference to the address space resource which represents Address space for P2S VpnClient.
    VpnClientIpsecPolicies List<Pulumi.AzureNative.Network.Inputs.IpsecPolicyResponse>
    VpnClientIpsecPolicies for virtual network gateway P2S client.
    VpnClientProtocols List<string>
    VpnClientProtocols for Virtual network gateway.
    VpnClientRevokedCertificates List<Pulumi.AzureNative.Network.Inputs.VpnClientRevokedCertificateResponse>
    VpnClientRevokedCertificate for Virtual network gateway.
    VpnClientRootCertificates List<Pulumi.AzureNative.Network.Inputs.VpnClientRootCertificateResponse>
    VpnClientRootCertificate for virtual network gateway.
    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 []RadiusServerResponse
    The radiusServers property for multiple radius server configuration.
    VpnAuthenticationTypes []string
    VPN authentication types for the virtual network gateway..
    VpnClientAddressPool AddressSpaceResponse
    The reference to the address space resource which represents Address space for P2S VpnClient.
    VpnClientIpsecPolicies []IpsecPolicyResponse
    VpnClientIpsecPolicies for virtual network gateway P2S client.
    VpnClientProtocols []string
    VpnClientProtocols for Virtual network gateway.
    VpnClientRevokedCertificates []VpnClientRevokedCertificateResponse
    VpnClientRevokedCertificate for Virtual network gateway.
    VpnClientRootCertificates []VpnClientRootCertificateResponse
    VpnClientRootCertificate for virtual network gateway.
    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 List<RadiusServerResponse>
    The radiusServers property for multiple radius server configuration.
    vpnAuthenticationTypes List<String>
    VPN authentication types for the virtual network gateway..
    vpnClientAddressPool AddressSpaceResponse
    The reference to the address space resource which represents Address space for P2S VpnClient.
    vpnClientIpsecPolicies List<IpsecPolicyResponse>
    VpnClientIpsecPolicies for virtual network gateway P2S client.
    vpnClientProtocols List<String>
    VpnClientProtocols for Virtual network gateway.
    vpnClientRevokedCertificates List<VpnClientRevokedCertificateResponse>
    VpnClientRevokedCertificate for Virtual network gateway.
    vpnClientRootCertificates List<VpnClientRootCertificateResponse>
    VpnClientRootCertificate for virtual network gateway.
    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 RadiusServerResponse[]
    The radiusServers property for multiple radius server configuration.
    vpnAuthenticationTypes string[]
    VPN authentication types for the virtual network gateway..
    vpnClientAddressPool AddressSpaceResponse
    The reference to the address space resource which represents Address space for P2S VpnClient.
    vpnClientIpsecPolicies IpsecPolicyResponse[]
    VpnClientIpsecPolicies for virtual network gateway P2S client.
    vpnClientProtocols string[]
    VpnClientProtocols for Virtual network gateway.
    vpnClientRevokedCertificates VpnClientRevokedCertificateResponse[]
    VpnClientRevokedCertificate for Virtual network gateway.
    vpnClientRootCertificates VpnClientRootCertificateResponse[]
    VpnClientRootCertificate for virtual network gateway.
    aad_audience str
    The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.
    aad_issuer str
    The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.
    aad_tenant str
    The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.
    radius_server_address str
    The radius server address property of the VirtualNetworkGateway resource for vpn client connection.
    radius_server_secret str
    The radius secret property of the VirtualNetworkGateway resource for vpn client connection.
    radius_servers Sequence[RadiusServerResponse]
    The radiusServers property for multiple radius server configuration.
    vpn_authentication_types Sequence[str]
    VPN authentication types for the virtual network gateway..
    vpn_client_address_pool AddressSpaceResponse
    The reference to the address space resource which represents Address space for P2S VpnClient.
    vpn_client_ipsec_policies Sequence[IpsecPolicyResponse]
    VpnClientIpsecPolicies for virtual network gateway P2S client.
    vpn_client_protocols Sequence[str]
    VpnClientProtocols for Virtual network gateway.
    vpn_client_revoked_certificates Sequence[VpnClientRevokedCertificateResponse]
    VpnClientRevokedCertificate for Virtual network gateway.
    vpn_client_root_certificates Sequence[VpnClientRootCertificateResponse]
    VpnClientRootCertificate for virtual network gateway.
    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 List<Property Map>
    The radiusServers property for multiple radius server configuration.
    vpnAuthenticationTypes List<String>
    VPN authentication types for the virtual network gateway..
    vpnClientAddressPool Property Map
    The reference to the address space resource which represents Address space for P2S VpnClient.
    vpnClientIpsecPolicies List<Property Map>
    VpnClientIpsecPolicies for virtual network gateway P2S client.
    vpnClientProtocols List<String>
    VpnClientProtocols for Virtual network gateway.
    vpnClientRevokedCertificates List<Property Map>
    VpnClientRevokedCertificate for Virtual network gateway.
    vpnClientRootCertificates List<Property Map>
    VpnClientRootCertificate for virtual network gateway.

    VpnClientRevokedCertificateResponse

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the VPN client revoked certificate resource.
    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.
    Thumbprint string
    The revoked VPN client certificate thumbprint.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the VPN client revoked certificate resource.
    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.
    Thumbprint string
    The revoked VPN client certificate thumbprint.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the VPN client revoked certificate resource.
    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.
    thumbprint String
    The revoked VPN client certificate thumbprint.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    provisioningState string
    The provisioning state of the VPN client revoked certificate resource.
    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.
    thumbprint string
    The revoked VPN client certificate thumbprint.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    provisioning_state str
    The provisioning state of the VPN client revoked certificate resource.
    id str
    Resource ID.
    name str
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    thumbprint str
    The revoked VPN client certificate thumbprint.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the VPN client revoked certificate resource.
    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.
    thumbprint String
    The revoked VPN client certificate thumbprint.

    VpnClientRootCertificateResponse

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the VPN client root certificate resource.
    PublicCertData string
    The certificate public data.
    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.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the VPN client root certificate resource.
    PublicCertData string
    The certificate public data.
    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.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the VPN client root certificate resource.
    publicCertData String
    The certificate public data.
    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.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    provisioningState string
    The provisioning state of the VPN client root certificate resource.
    publicCertData string
    The certificate public data.
    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.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    provisioning_state str
    The provisioning state of the VPN client root certificate resource.
    public_cert_data str
    The certificate public data.
    id str
    Resource ID.
    name str
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the VPN client root certificate resource.
    publicCertData String
    The certificate public data.
    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.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native