Gets the specified local network gateway in a resource group.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}?api-version=2023-09-01
URI Parameters
Name |
In |
Required |
Type |
Description |
localNetworkGatewayName
|
path |
True
|
string
|
The name of the local network gateway.
|
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.
|
api-version
|
query |
True
|
string
|
Client API version.
|
Responses
Name |
Type |
Description |
200 OK
|
LocalNetworkGateway
|
Request successful. The operation returns the resulting LocalNetworkGateway 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
GetLocalNetworkGateway
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw?api-version=2023-09-01
/**
* Samples for LocalNetworkGateways GetByResourceGroup.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/LocalNetworkGatewayGet.json
*/
/**
* Sample code: GetLocalNetworkGateway.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getLocalNetworkGateway(com.azure.resourcemanager.AzureResourceManager azure) {
azure.networks().manager().serviceClient().getLocalNetworkGateways().getByResourceGroupWithResponse("rg1",
"localgw", 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 local_network_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.local_network_gateways.get(
resource_group_name="rg1",
local_network_gateway_name="localgw",
)
print(response)
# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/LocalNetworkGatewayGet.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/LocalNetworkGatewayGet.json
func ExampleLocalNetworkGatewaysClient_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.NewLocalNetworkGatewaysClient().Get(ctx, "rg1", "localgw", 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.LocalNetworkGateway = armnetwork.LocalNetworkGateway{
// Name: to.Ptr("localgw"),
// Type: to.Ptr("Microsoft.Network/localNetworkGateways"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw"),
// Location: to.Ptr("centralus"),
// Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
// Properties: &armnetwork.LocalNetworkGatewayPropertiesFormat{
// GatewayIPAddress: to.Ptr("x.x.x.x"),
// LocalNetworkAddressSpace: &armnetwork.AddressSpace{
// AddressPrefixes: []*string{
// to.Ptr("10.1.0.0/16")},
// },
// ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
// ResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// },
// }
}
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 local network gateway in a resource group.
*
* @summary Gets the specified local network gateway in a resource group.
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/LocalNetworkGatewayGet.json
*/
async function getLocalNetworkGateway() {
const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
const localNetworkGatewayName = "localgw";
const credential = new DefaultAzureCredential();
const client = new NetworkManagementClient(credential, subscriptionId);
const result = await client.localNetworkGateways.get(resourceGroupName, localNetworkGatewayName);
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.Resources;
// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/LocalNetworkGatewayGet.json
// this example is just showing the usage of "LocalNetworkGateways_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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);
// get the collection of this LocalNetworkGatewayResource
LocalNetworkGatewayCollection collection = resourceGroupResource.GetLocalNetworkGateways();
// invoke the operation
string localNetworkGatewayName = "localgw";
NullableResponse<LocalNetworkGatewayResource> response = await collection.GetIfExistsAsync(localNetworkGatewayName);
LocalNetworkGatewayResource result = response.HasValue ? response.Value : null;
if (result == null)
{
Console.WriteLine($"Succeeded with null as result");
}
else
{
// 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
LocalNetworkGatewayData 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": "localgw",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw",
"etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"type": "Microsoft.Network/localNetworkGateways",
"location": "centralus",
"properties": {
"provisioningState": "Succeeded",
"resourceGuid": "00000000-0000-0000-0000-000000000000",
"localNetworkAddressSpace": {
"addressPrefixes": [
"10.1.0.0/16"
]
},
"gatewayIpAddress": "x.x.x.x"
}
}
Definitions
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.
|
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.
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.
|
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.
|
LocalNetworkGateway
A common class for general resource information.
Name |
Type |
Description |
etag
|
string
|
A unique read-only string that changes whenever the resource is updated.
|
id
|
string
|
Resource ID.
|
location
|
string
|
Resource location.
|
name
|
string
|
Resource name.
|
properties.bgpSettings
|
BgpSettings
|
Local network gateway's BGP speaker settings.
|
properties.fqdn
|
string
|
FQDN of local network gateway.
|
properties.gatewayIpAddress
|
string
|
IP address of local network gateway.
|
properties.localNetworkAddressSpace
|
AddressSpace
|
Local network site address space.
|
properties.provisioningState
|
ProvisioningState
|
The provisioning state of the local network gateway resource.
|
properties.resourceGuid
|
string
|
The resource GUID property of the local network gateway resource.
|
tags
|
object
|
Resource tags.
|
type
|
string
|
Resource type.
|
ProvisioningState
The current provisioning state.
Name |
Type |
Description |
Deleting
|
string
|
|
Failed
|
string
|
|
Succeeded
|
string
|
|
Updating
|
string
|
|