Obtém a regra especificada de um filtro de rota.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}?api-version=2023-09-01
Parâmetros de URI
| Nome |
Em |
Obrigatório |
Tipo |
Description |
|
resourceGroupName
|
path |
True
|
string
|
O nome do grupo de recursos.
|
|
routeFilterName
|
path |
True
|
string
|
O nome do filtro de rota.
|
|
ruleName
|
path |
True
|
string
|
O nome da regra.
|
|
subscriptionId
|
path |
True
|
string
|
As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
|
|
api-version
|
query |
True
|
string
|
Versão de API do cliente.
|
Respostas
| Nome |
Tipo |
Description |
|
200 OK
|
RouteFilterRule
|
Solicitação bem-sucedida. A operação retorna o recurso de Regra de Filtro de Rota resultante.
|
|
Other Status Codes
|
CloudError
|
Resposta de erro que descreve por que a operação falhou.
|
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Nome |
Description |
|
user_impersonation
|
representar sua conta de usuário
|
Exemplos
RouteFilterRuleGet
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/filterName?api-version=2023-09-01
/**
* Samples for RouteFilterRules Get.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/RouteFilterRuleGet.json
*/
/**
* Sample code: RouteFilterRuleGet.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void routeFilterRuleGet(com.azure.resourcemanager.AzureResourceManager azure) {
azure.networks().manager().serviceClient().getRouteFilterRules().getWithResponse("rg1", "filterName",
"filterName", 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 route_filter_rule_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.route_filter_rules.get(
resource_group_name="rg1",
route_filter_name="filterName",
rule_name="filterName",
)
print(response)
# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/RouteFilterRuleGet.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/RouteFilterRuleGet.json
func ExampleRouteFilterRulesClient_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.NewRouteFilterRulesClient().Get(ctx, "rg1", "filterName", "filterName", 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.RouteFilterRule = armnetwork.RouteFilterRule{
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName"),
// Name: to.Ptr("ruleName"),
// Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
// Properties: &armnetwork.RouteFilterRulePropertiesFormat{
// Access: to.Ptr(armnetwork.AccessAllow),
// Communities: []*string{
// to.Ptr("12076:5030"),
// to.Ptr("12076:5040")},
// ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
// RouteFilterRuleType: to.Ptr(armnetwork.RouteFilterRuleTypeCommunity),
// },
// }
}
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 rule from a route filter.
*
* @summary Gets the specified rule from a route filter.
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/RouteFilterRuleGet.json
*/
async function routeFilterRuleGet() {
const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
const routeFilterName = "filterName";
const ruleName = "filterName";
const credential = new DefaultAzureCredential();
const client = new NetworkManagementClient(credential, subscriptionId);
const result = await client.routeFilterRules.get(resourceGroupName, routeFilterName, ruleName);
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;
// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/RouteFilterRuleGet.json
// this example is just showing the usage of "RouteFilterRules_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 RouteFilterResource created on azure
// for more information of creating RouteFilterResource, please refer to the document of RouteFilterResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string routeFilterName = "filterName";
ResourceIdentifier routeFilterResourceId = RouteFilterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, routeFilterName);
RouteFilterResource routeFilter = client.GetRouteFilterResource(routeFilterResourceId);
// get the collection of this RouteFilterRuleResource
RouteFilterRuleCollection collection = routeFilter.GetRouteFilterRules();
// invoke the operation
string ruleName = "filterName";
NullableResponse<RouteFilterRuleResource> response = await collection.GetIfExistsAsync(ruleName);
RouteFilterRuleResource 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
RouteFilterRuleData 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
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"name": "ruleName",
"properties": {
"provisioningState": "Succeeded",
"access": "Allow",
"routeFilterRuleType": "Community",
"communities": [
"12076:5030",
"12076:5040"
]
}
}
Definições
Access
Acesso a ser permitido ou negado.
| Nome |
Tipo |
Description |
|
Allow
|
string
|
|
|
Deny
|
string
|
|
CloudError
Uma resposta de erro do serviço.
CloudErrorBody
Uma resposta de erro do serviço.
| Nome |
Tipo |
Description |
|
code
|
string
|
Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
|
|
details
|
CloudErrorBody[]
|
Uma lista de detalhes adicionais sobre o erro.
|
|
message
|
string
|
Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
|
|
target
|
string
|
O destino do erro específico. Por exemplo, o nome da propriedade em erro.
|
ProvisioningState
O estado de provisionamento atual.
| Nome |
Tipo |
Description |
|
Deleting
|
string
|
|
|
Failed
|
string
|
|
|
Succeeded
|
string
|
|
|
Updating
|
string
|
|
RouteFilterRule
Recurso de regra de filtro de rota.
| Nome |
Tipo |
Description |
|
etag
|
string
|
Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
|
|
id
|
string
|
ID do recurso.
|
|
location
|
string
|
Local do recurso.
|
|
name
|
string
|
O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
|
|
properties.access
|
Access
|
O tipo de acesso da regra.
|
|
properties.communities
|
string[]
|
A coleção de valores da comunidade bgp para filtrar. por exemplo, ['12076:5010','12076:5020'].
|
|
properties.provisioningState
|
ProvisioningState
|
O estado de provisionamento do recurso de regra de filtro de rota.
|
|
properties.routeFilterRuleType
|
RouteFilterRuleType
|
O tipo de regra da regra.
|
RouteFilterRuleType
O tipo de regra da regra.
| Nome |
Tipo |
Description |
|
Community
|
string
|
|