Edit

Share via

Get-AzNetworkManagerRoutingRuleCollection

  • Reference
Module:
Az.Network

Gets a routing rule collection in a network manager.

Syntax

Get-AzNetworkManagerRoutingRuleCollection
   -RoutingConfigurationName <String>
   -NetworkManagerName <String>
   -ResourceGroupName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzNetworkManagerRoutingRuleCollection
   -Name <String>
   -RoutingConfigurationName <String>
   -NetworkManagerName <String>
   -ResourceGroupName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzNetworkManagerRoutingRuleCollection
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzNetworkManagerRoutingRuleCollection cmdlet gets a routing rule collection in a network manager.

Examples

Example 1

Get-AzNetworkManagerRoutingRuleCollection  -Name "TestRC" -RoutingConfigurationName "TestRoutingConfig" -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG"

Name              : TestRC
Description       : Sample rule Collection Description
Id                : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/routingConfigurations/TestRoutingConfig/ruleCollections/TestRC
Type              : Microsoft.Network/networkManagers/routingConfigurations/ruleCollections
Etag              : "00000000-0000-0000-0000-000000000000"
ProvisioningState : Succeeded
AppliesTo         : [
                      {
                        "NetworkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/testng"
                      }
                    ]
DisableBgpRoutePropagation : "False"
SystemData        : {
                      "CreatedBy": "00000000-0000-0000-0000-000000000000",
                      "CreatedByType": "Application",
                      "CreatedAt": "2021-10-18T04:06:01",
                      "LastModifiedBy": "00000000-0000-0000-0000-000000000000",
                      "LastModifiedByType": "Application",
                      "LastModifiedAt": "2021-10-18T04:06:03"
                    }

Gets a rule collection within a routing configuration.

Example 2

Get-AzNetworkManagerRoutingRuleCollection  -RoutingConfigurationName "TestRoutingConfig" -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG"

Name              : TestRC
Description       : Sample rule Collection Description
Id                : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/routingConfigurations/TestRoutingConfig/ruleCollections/TestRC
Type              : Microsoft.Network/networkManagers/routingConfigurations/ruleCollections
Etag              : "00000000-0000-0000-0000-000000000000"
ProvisioningState : Succeeded
AppliesTo         : [
                      {
                        "NetworkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/testng"
                      }
                    ]
DisableBgpRoutePropagation : "False"
SystemData        : {
                      "CreatedBy": "00000000-0000-0000-0000-000000000000",
                      "CreatedByType": "Application",
                      "CreatedAt": "2021-10-18T04:06:01",
                      "LastModifiedBy": "00000000-0000-0000-0000-000000000000",
                      "LastModifiedByType": "Application",
                      "LastModifiedAt": "2021-10-18T04:06:03"
                    }

Name              : TestRC2
Description       : Sample rule Collection Description
Id                : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/routingConfigurations/TestRoutingConfig/ruleCollections/TestRC2
Type              : Microsoft.Network/networkManagers/routingConfigurations/ruleCollections
Etag              : "00000000-0000-0000-0000-000000000000"
ProvisioningState : Succeeded
AppliesTo         : [
                      {
                        "NetworkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/testng"
                      }
                    ]
SystemData        : {
                      "CreatedBy": "00000000-0000-0000-0000-000000000000",
                      "CreatedByType": "Application",
                      "CreatedAt": "2021-10-18T04:06:01",
                      "LastModifiedBy": "00000000-0000-0000-0000-000000000000",
                      "LastModifiedByType": "Application",
                      "LastModifiedAt": "2021-10-18T04:06:03"
                    }

Gets all rule collections within a routing configuration.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

The resource name.

Type:String
Aliases:ResourceName
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-NetworkManagerName

The network manager name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-ResourceGroupName

The resource group name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-ResourceId

NetworkManager RoutingCollection Id

Type:String
Aliases:RoutingCollectionId
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-RoutingConfigurationName

The network manager routing configuration name.

Type:String
Aliases:ConfigName
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

Inputs

String

Outputs

PSNetworkManagerRoutingRuleCollection