Hämtar de inkommande vägarna som konfigurerats för den virtuella hubben på en viss anslutning.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/inboundRoutes?api-version=2023-09-01
URI-parametrar
Name |
I |
Obligatorisk |
Typ |
Description |
resourceGroupName
|
path |
True
|
string
|
Namnet på resursgruppen för VirtualHub.
|
subscriptionId
|
path |
True
|
string
|
Autentiseringsuppgifterna för prenumerationen som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
|
virtualHubName
|
path |
True
|
string
|
Namnet på VirtualHub.
|
api-version
|
query |
True
|
string
|
Klient-API-version.
|
Begärandetext
Name |
Typ |
Description |
connectionType
|
string
|
Typen av angiven anslutningsresurs som ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection och P2SConnection.
|
resourceUri
|
string
|
Anslutningsresursen vars inkommande vägar begärs.
|
Svar
Name |
Typ |
Description |
200 OK
|
EffectiveRouteMapRouteList
|
Begäran lyckades. Returnerar listan över de effektiva routningsvägarna eller följer platsrubriken för listan över inkommande vägar.
|
202 Accepted
|
|
Accepterad och åtgärden slutförs asynkront.
|
Other Status Codes
|
CloudError
|
Felsvar som beskriver varför åtgärden misslyckades.
|
Säkerhet
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
|
personifiera ditt användarkonto
|
Exempel
Inbound Routes for the Virtual Hub on a Particular Connection
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/inboundRoutes?api-version=2023-09-01
{
"resourceUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1",
"connectionType": "ExpressRouteConnection"
}
from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-network
# USAGE
python get_inbound_routes.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.virtual_hubs.begin_get_inbound_routes(
resource_group_name="rg1",
virtual_hub_name="virtualHub1",
get_inbound_routes_parameters={
"connectionType": "ExpressRouteConnection",
"resourceUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1",
},
).result()
print(response)
# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GetInboundRoutes.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/azcore/to"
"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/GetInboundRoutes.json
func ExampleVirtualHubsClient_BeginGetInboundRoutes() {
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)
}
poller, err := clientFactory.NewVirtualHubsClient().BeginGetInboundRoutes(ctx, "rg1", "virtualHub1", armnetwork.GetInboundRoutesParameters{
ConnectionType: to.Ptr("ExpressRouteConnection"),
ResourceURI: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1"),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %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.EffectiveRouteMapRouteList = armnetwork.EffectiveRouteMapRouteList{
// }
}
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 inbound routes configured for the Virtual Hub on a particular connection.
*
* @summary Gets the inbound routes configured for the Virtual Hub on a particular connection.
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GetInboundRoutes.json
*/
async function inboundRoutesForTheVirtualHubOnAParticularConnection() {
const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
const virtualHubName = "virtualHub1";
const getInboundRoutesParameters = {
connectionType: "ExpressRouteConnection",
resourceUri:
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1",
};
const credential = new DefaultAzureCredential();
const client = new NetworkManagementClient(credential, subscriptionId);
const result = await client.virtualHubs.beginGetInboundRoutesAndWait(
resourceGroupName,
virtualHubName,
getInboundRoutesParameters,
);
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.Network.Models;
using Azure.ResourceManager.Resources;
// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GetInboundRoutes.json
// this example is just showing the usage of "VirtualHubs_GetInboundRoutes" 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 VirtualHubResource created on azure
// for more information of creating VirtualHubResource, please refer to the document of VirtualHubResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualHubName = "virtualHub1";
ResourceIdentifier virtualHubResourceId = VirtualHubResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualHubName);
VirtualHubResource virtualHub = client.GetVirtualHubResource(virtualHubResourceId);
// invoke the operation
VirtualHubInboundRoutesContent content = new VirtualHubInboundRoutesContent()
{
ResourceUri = new Uri("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1"),
ConnectionType = "ExpressRouteConnection",
};
ArmOperation<EffectiveRouteMapRouteList> lro = await virtualHub.GetVirtualHubInboundRoutesAsync(WaitUntil.Completed, content);
EffectiveRouteMapRouteList result = lro.Value;
Console.WriteLine($"Succeeded: {result}");
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
{
"value": [
{
"prefix": "192.168.50.0/24",
"asPath": "65520-65520",
"bgpCommunities": "4293853166,12076,51004"
},
{
"prefix": "10.200.0.0/16",
"asPath": "65520-65520-12076-12076",
"bgpCommunities": "4293787629,12076,51027,4293734188"
}
]
}
Location: https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Network/locations/region/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-09-01
Definitioner
CloudError
Ett felsvar från tjänsten.
CloudErrorBody
Ett felsvar från tjänsten.
Name |
Typ |
Description |
code
|
string
|
En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
|
details
|
CloudErrorBody[]
|
En lista med ytterligare information om felet.
|
message
|
string
|
Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
|
target
|
string
|
Målet för det specifika felet. Till exempel namnet på egenskapen i fel.
|
EffectiveRouteMapRoute
Den effektiva RouteMap-vägen som konfigurerats för anslutningsresursen.
Name |
Typ |
Description |
asPath
|
string
|
ASPath för den här vägen.
|
bgpCommunities
|
string
|
BGP-communities för rutten.
|
prefix
|
string
|
Adressprefixet för vägen.
|
EffectiveRouteMapRouteList
EffectiveRouteMapRoute-lista.
Name |
Typ |
Description |
value
|
EffectiveRouteMapRoute[]
|
Listan över effektiva RouteMap-vägar som konfigurerats för anslutningsresursen.
|
GetInboundRoutesParameters
Parametrarna som anger anslutningsresursen vars inkommande vägar begärs.
Name |
Typ |
Description |
connectionType
|
string
|
Typen av angiven anslutningsresurs som ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection och P2SConnection.
|
resourceUri
|
string
|
Anslutningsresursen vars inkommande vägar begärs.
|