Ruft die ausgehenden Routen ab, die für den virtuellen Hub für eine bestimmte Verbindung konfiguriert sind.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/outboundRoutes?api-version=2023-09-01
URI-Parameter
| Name |
In |
Erforderlich |
Typ |
Beschreibung |
|
resourceGroupName
|
path |
True
|
string
|
Der Ressourcengruppenname des VirtualHub.
|
|
subscriptionId
|
path |
True
|
string
|
Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
|
|
virtualHubName
|
path |
True
|
string
|
Der Name des VirtualHub.
|
|
api-version
|
query |
True
|
string
|
Client-API-Version.
|
Anforderungstext
| Name |
Typ |
Beschreibung |
|
connectionType
|
string
|
Der Typ der angegebenen Verbindungsressource wie ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection und P2SConnection.
|
|
resourceUri
|
string
|
Die Verbindungsressource, deren ausgehende Routen angefordert werden.
|
Antworten
| Name |
Typ |
Beschreibung |
|
200 OK
|
EffectiveRouteMapRouteList
|
Anforderung erfolgreich. Gibt die Liste der effektiven Routen für die Routenzuordnung zurück, oder folgen Sie der Positionsheader für die Liste ausgehender Routen.
|
|
202 Accepted
|
|
Wird akzeptiert, und der Vorgang wird asynchron abgeschlossen.
|
|
Other Status Codes
|
CloudError
|
Fehlerantwort mit Beschreibung des Grunds für den Fehler.
|
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Beschreibung |
|
user_impersonation
|
Identitätswechsel Ihres Benutzerkontos
|
Beispiele
Outbound 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/outboundRoutes?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_outbound_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_outbound_routes(
resource_group_name="rg1",
virtual_hub_name="virtualHub1",
get_outbound_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/GetOutboundRoutes.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/GetOutboundRoutes.json
func ExampleVirtualHubsClient_BeginGetOutboundRoutes() {
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().BeginGetOutboundRoutes(ctx, "rg1", "virtualHub1", armnetwork.GetOutboundRoutesParameters{
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 outbound routes configured for the Virtual Hub on a particular connection.
*
* @summary Gets the outbound 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/GetOutboundRoutes.json
*/
async function outboundRoutesForTheVirtualHubOnAParticularConnection() {
const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
const virtualHubName = "virtualHub1";
const getOutboundRoutesParameters = {
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.beginGetOutboundRoutesAndWait(
resourceGroupName,
virtualHubName,
getOutboundRoutesParameters,
);
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/GetOutboundRoutes.json
// this example is just showing the usage of "VirtualHubs_GetOutboundRoutes" 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
VirtualHubOutboundRoutesContent content = new VirtualHubOutboundRoutesContent()
{
ResourceUri = new Uri("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1"),
ConnectionType = "ExpressRouteConnection",
};
ArmOperation<EffectiveRouteMapRouteList> lro = await virtualHub.GetVirtualHubOutboundRoutesAsync(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
Definitionen
CloudError
Eine Fehlerantwort vom Dienst.
CloudErrorBody
Eine Fehlerantwort vom Dienst.
| Name |
Typ |
Beschreibung |
|
code
|
string
|
Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
|
|
details
|
CloudErrorBody[]
|
Eine Liste mit zusätzlichen Details zum Fehler.
|
|
message
|
string
|
Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
|
|
target
|
string
|
Das Ziel des jeweiligen Fehlers. Beispiel: Der Name der -Eigenschaft im Fehler.
|
EffectiveRouteMapRoute
Die effektive RouteMap-Route, die für die Verbindungsressource konfiguriert ist.
| Name |
Typ |
Beschreibung |
|
asPath
|
string
|
Der ASPath dieser Route.
|
|
bgpCommunities
|
string
|
BGP-Gemeinden der Route.
|
|
prefix
|
string
|
Das Adresspräfix der Route.
|
EffectiveRouteMapRouteList
EffectiveRouteMapRoute-Liste.
| Name |
Typ |
Beschreibung |
|
value
|
EffectiveRouteMapRoute[]
|
Die Liste der effektiven RouteMap-Routen, die für die Verbindungsressource konfiguriert sind.
|
GetOutboundRoutesParameters
Die Parameter, die die Verbindungsressource angeben, deren ausgehende Routen angefordert werden.
| Name |
Typ |
Beschreibung |
|
connectionType
|
string
|
Der Typ der angegebenen Verbindungsressource wie ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection und P2SConnection.
|
|
resourceUri
|
string
|
Die Verbindungsressource, deren ausgehende Routen angefordert werden.
|