Bir kaynak grubunda belirtilen yerel ağ geçidini alır.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}?api-version=2023-09-01
URI Parametreleri
Name |
İçinde |
Gerekli |
Tür |
Description |
localNetworkGatewayName
|
path |
True
|
string
|
Yerel ağ geçidinin adı.
|
resourceGroupName
|
path |
True
|
string
|
Kaynak grubunun adı.
|
subscriptionId
|
path |
True
|
string
|
Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
|
api-version
|
query |
True
|
string
|
İstemci API sürümü.
|
Yanıtlar
Name |
Tür |
Description |
200 OK
|
LocalNetworkGateway
|
İstek başarılı oldu. İşlem, sonuçta elde edilen LocalNetworkGateway kaynağını döndürür.
|
Other Status Codes
|
CloudError
|
İşlemin neden başarısız olduğunu açıklayan hata yanıtı.
|
Güvenlik
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
|
kullanıcı hesabınızın kimliğine bürünme
|
Örnekler
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"
}
}
Tanımlar
AddressSpace
AddressSpace, sanal ağın alt ağları tarafından kullanılabilecek bir IP adresi aralıkları dizisi içerir.
Name |
Tür |
Description |
addressPrefixes
|
string[]
|
CIDR gösteriminde bu sanal ağ için ayrılmış adres bloklarının listesi.
|
BgpSettings
BGP ayarları ayrıntıları.
Name |
Tür |
Description |
asn
|
integer
|
BGP konuşmacısının ASN'sini.
|
bgpPeeringAddress
|
string
|
Bu BGP konuşmacısının BGP eşleme adresi ve BGP tanımlayıcısı.
|
bgpPeeringAddresses
|
IPConfigurationBgpPeeringAddress[]
|
Sanal ağ geçidi için IP yapılandırma kimliğine sahip BGP eşleme adresi.
|
peerWeight
|
integer
|
Bu BGP hoparlöründen öğrenilen rotalara eklenen ağırlık.
|
CloudError
Hizmetten bir hata yanıtı.
CloudErrorBody
Hizmetten bir hata yanıtı.
Name |
Tür |
Description |
code
|
string
|
Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.
|
details
|
CloudErrorBody[]
|
Hatayla ilgili ek ayrıntıların listesi.
|
message
|
string
|
Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.
|
target
|
string
|
Belirli bir hatanın hedefi. Örneğin, özelliğin adı hatalı.
|
IPConfigurationBgpPeeringAddress
IPConfigurationBgpPeeringAddress özellikleri.
Name |
Tür |
Description |
customBgpIpAddresses
|
string[]
|
IP yapılandırmasına ait özel BGP eşleme adreslerinin listesi.
|
defaultBgpIpAddresses
|
string[]
|
IP yapılandırmasına ait varsayılan BGP eşleme adreslerinin listesi.
|
ipconfigurationId
|
string
|
Ağ geçidine ait IP yapılandırmasının kimliği.
|
tunnelIpAddresses
|
string[]
|
IP yapılandırmasına ait tünel genel IP adreslerinin listesi.
|
LocalNetworkGateway
Genel kaynak bilgileri için ortak bir sınıf.
Name |
Tür |
Description |
etag
|
string
|
Kaynak her güncelleştirildiğinde değişen benzersiz bir salt okunur dize.
|
id
|
string
|
Kaynak Kimliği.
|
location
|
string
|
Kaynak konumu.
|
name
|
string
|
Kaynak adı.
|
properties.bgpSettings
|
BgpSettings
|
Yerel ağ geçidinin BGP hoparlör ayarları.
|
properties.fqdn
|
string
|
Yerel ağ geçidinin FQDN'sini seçin.
|
properties.gatewayIpAddress
|
string
|
Yerel ağ geçidinin IP adresi.
|
properties.localNetworkAddressSpace
|
AddressSpace
|
Yerel ağ sitesi adres alanı.
|
properties.provisioningState
|
ProvisioningState
|
Yerel ağ geçidi kaynağının sağlama durumu.
|
properties.resourceGuid
|
string
|
Yerel ağ geçidi kaynağının kaynak GUID özelliği.
|
tags
|
object
|
Kaynak etiketleri.
|
type
|
string
|
Kaynak türü.
|
ProvisioningState
Geçerli sağlama durumu.
Name |
Tür |
Description |
Deleting
|
string
|
|
Failed
|
string
|
|
Succeeded
|
string
|
|
Updating
|
string
|
|