Set-AzNetworkManagerRoutingRule
Updates a network manager routing rule.
Syntax
Set-AzNetworkManagerRoutingRule
-InputObject <PSNetworkManagerRoutingRule>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzNetworkManagerRoutingRule
-Name <String>
-ResourceGroupName <String>
-NetworkManagerName <String>
-RoutingConfigurationName <String>
-RuleCollectionName <String>
-DestinationAddress <String>
-DestinationType <String>
[-NextHopAddress <String>]
-NextHopType <String>
[-Description <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzNetworkManagerRoutingRule
-ResourceId <String>
-DestinationAddress <String>
-DestinationType <String>
[-NextHopAddress <String>]
-NextHopType <String>
[-Description <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzNetworkManagerRoutingRule cmdlet updates a network manager routing rule.
Examples
Example 1
$destination = New-AzNetworkManagerRoutingRuleDestination -DestinationAddress "10.1.1.1/32" -Type "AddressPrefix"
$RoutingRule = Get-AzNetworkManagerRoutingRule -Name "psRule" -RuleCollectionName "psRuleCollection" -RoutingConfigurationName "psRoutingConfig" -NetworkManagerName "psNetworkManager" -ResourceGroupName "psResourceGroup"
Set-AzNetworkManagerRoutingRule -InputObject $RoutingRule
Destination : {Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerRoutingRuleDestination}
NextHop : {Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerRoutingRuleNextHop}
DestinationText : [
{
"DestinationAddress": "10.1.1.1/32",
"Type": "AddressPrefix"
}
]
NextHopText : [
{
"AddressNextHopType": "NoNextHop"
}
]
DisplayName :
Description : TestDescription
Type : Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules
ProvisioningState : Succeeded
SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData
SystemDataTest : {
"CreatedBy": "00000000-0000-0000-0000-000000000000",
"CreatedByType": "Application",
"CreatedAt": "2021-10-18T04:05:57",
"LastModifiedBy": "00000000-0000-0000-0000-000000000000",
"LastModifiedByType": "Application",
"LastModifiedAt": "2021-10-18T04:05:59"
}
Name : psRule
Etag :
Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/routingConfigurations/psRoutingConfig/ruleCollections/psRuleCollection/rules/psRule
Updates a network manager routing rule's destination.
Parameters
-AsJob
Run cmdlet in the background
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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 |
-Description
Description.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DestinationAddress
The routing rule destination address.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DestinationType
The routing rule destination type.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InputObject
The Network Manager Routing Rule
Type: | PSNetworkManagerRoutingRule |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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: | False |
Accept wildcard characters: | False |
-NextHopAddress
The routing rule next hop address.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NextHopType
The routing rule next hop type.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
The resource group name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceId
NetworkManager RoutingRule Id
Type: | String |
Aliases: | RoutingRuleId |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-RoutingConfigurationName
The routing configuration name.
Type: | String |
Aliases: | ConfigName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RuleCollectionName
The rule collection name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |