azure-native.network.RoutingRule
Explore with Pulumi AI
Network routing rule.
Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2024-03-01.
Other available API versions: 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]
. See the version guide for details.
Create RoutingRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RoutingRule(name: string, args: RoutingRuleArgs, opts?: CustomResourceOptions);
@overload
def RoutingRule(resource_name: str,
args: RoutingRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RoutingRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
configuration_name: Optional[str] = None,
destination: Optional[RoutingRuleRouteDestinationArgs] = None,
network_manager_name: Optional[str] = None,
next_hop: Optional[RoutingRuleNextHopArgs] = None,
resource_group_name: Optional[str] = None,
rule_collection_name: Optional[str] = None,
description: Optional[str] = None,
rule_name: Optional[str] = None)
func NewRoutingRule(ctx *Context, name string, args RoutingRuleArgs, opts ...ResourceOption) (*RoutingRule, error)
public RoutingRule(string name, RoutingRuleArgs args, CustomResourceOptions? opts = null)
public RoutingRule(String name, RoutingRuleArgs args)
public RoutingRule(String name, RoutingRuleArgs args, CustomResourceOptions options)
type: azure-native:network:RoutingRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. RoutingRuleArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. RoutingRuleArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. RoutingRuleArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. RoutingRuleArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. RoutingRuleArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var routingRuleResource = new AzureNative.Network.RoutingRule("routingRuleResource", new()
{
ConfigurationName = "string",
Destination = new AzureNative.Network.Inputs.RoutingRuleRouteDestinationArgs
{
DestinationAddress = "string",
Type = "string",
},
NetworkManagerName = "string",
NextHop = new AzureNative.Network.Inputs.RoutingRuleNextHopArgs
{
NextHopType = "string",
NextHopAddress = "string",
},
ResourceGroupName = "string",
RuleCollectionName = "string",
Description = "string",
RuleName = "string",
});
example, err := network.NewRoutingRule(ctx, "routingRuleResource", &network.RoutingRuleArgs{
ConfigurationName: pulumi.String("string"),
Destination: &network.RoutingRuleRouteDestinationArgs{
DestinationAddress: pulumi.String("string"),
Type: pulumi.String("string"),
},
NetworkManagerName: pulumi.String("string"),
NextHop: &network.RoutingRuleNextHopArgs{
NextHopType: pulumi.String("string"),
NextHopAddress: pulumi.String("string"),
},
ResourceGroupName: pulumi.String("string"),
RuleCollectionName: pulumi.String("string"),
Description: pulumi.String("string"),
RuleName: pulumi.String("string"),
})
var routingRuleResource = new RoutingRule("routingRuleResource", RoutingRuleArgs.builder()
.configurationName("string")
.destination(RoutingRuleRouteDestinationArgs.builder()
.destinationAddress("string")
.type("string")
.build())
.networkManagerName("string")
.nextHop(RoutingRuleNextHopArgs.builder()
.nextHopType("string")
.nextHopAddress("string")
.build())
.resourceGroupName("string")
.ruleCollectionName("string")
.description("string")
.ruleName("string")
.build());
routing_rule_resource = azure_native.network.RoutingRule("routingRuleResource",
configuration_name="string",
destination={
"destination_address": "string",
"type": "string",
},
network_manager_name="string",
next_hop={
"next_hop_type": "string",
"next_hop_address": "string",
},
resource_group_name="string",
rule_collection_name="string",
description="string",
rule_name="string")
const routingRuleResource = new azure_native.network.RoutingRule("routingRuleResource", {
configurationName: "string",
destination: {
destinationAddress: "string",
type: "string",
},
networkManagerName: "string",
nextHop: {
nextHopType: "string",
nextHopAddress: "string",
},
resourceGroupName: "string",
ruleCollectionName: "string",
description: "string",
ruleName: "string",
});
type: azure-native:network:RoutingRule
properties:
configurationName: string
description: string
destination:
destinationAddress: string
type: string
networkManagerName: string
nextHop:
nextHopAddress: string
nextHopType: string
resourceGroupName: string
ruleCollectionName: string
ruleName: string
RoutingRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The RoutingRule resource accepts the following input properties:
- Configuration
Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager Routing Configuration.
- Destination
This property is required. Pulumi.Azure Native. Network. Inputs. Routing Rule Route Destination - Indicates the destination for this particular rule.
- Network
Manager Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager.
- Next
Hop This property is required. Pulumi.Azure Native. Network. Inputs. Routing Rule Next Hop - Indicates the next hop for this particular rule.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Rule
Collection Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager routing Configuration rule collection.
- Description string
- A description for this rule.
- Rule
Name Changes to this property will trigger replacement.
- The name of the rule.
- Configuration
Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager Routing Configuration.
- Destination
This property is required. RoutingRule Route Destination Args - Indicates the destination for this particular rule.
- Network
Manager Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager.
- Next
Hop This property is required. RoutingRule Next Hop Args - Indicates the next hop for this particular rule.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Rule
Collection Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager routing Configuration rule collection.
- Description string
- A description for this rule.
- Rule
Name Changes to this property will trigger replacement.
- The name of the rule.
- configuration
Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager Routing Configuration.
- destination
This property is required. RoutingRule Route Destination - Indicates the destination for this particular rule.
- network
Manager Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager.
- next
Hop This property is required. RoutingRule Next Hop - Indicates the next hop for this particular rule.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- rule
Collection Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager routing Configuration rule collection.
- description String
- A description for this rule.
- rule
Name Changes to this property will trigger replacement.
- The name of the rule.
- configuration
Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager Routing Configuration.
- destination
This property is required. RoutingRule Route Destination - Indicates the destination for this particular rule.
- network
Manager Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager.
- next
Hop This property is required. RoutingRule Next Hop - Indicates the next hop for this particular rule.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- rule
Collection Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager routing Configuration rule collection.
- description string
- A description for this rule.
- rule
Name Changes to this property will trigger replacement.
- The name of the rule.
- configuration_
name This property is required. Changes to this property will trigger replacement.
- The name of the network manager Routing Configuration.
- destination
This property is required. RoutingRule Route Destination Args - Indicates the destination for this particular rule.
- network_
manager_ name This property is required. Changes to this property will trigger replacement.
- The name of the network manager.
- next_
hop This property is required. RoutingRule Next Hop Args - Indicates the next hop for this particular rule.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- rule_
collection_ name This property is required. Changes to this property will trigger replacement.
- The name of the network manager routing Configuration rule collection.
- description str
- A description for this rule.
- rule_
name Changes to this property will trigger replacement.
- The name of the rule.
- configuration
Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager Routing Configuration.
- destination
This property is required. Property Map - Indicates the destination for this particular rule.
- network
Manager Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager.
- next
Hop This property is required. Property Map - Indicates the next hop for this particular rule.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- rule
Collection Name This property is required. Changes to this property will trigger replacement.
- The name of the network manager routing Configuration rule collection.
- description String
- A description for this rule.
- rule
Name Changes to this property will trigger replacement.
- The name of the rule.
Outputs
All input properties are implicitly available as output properties. Additionally, the RoutingRule resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Etag string
- A unique read-only string that changes whenever the resource is updated.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name.
- Provisioning
State string - The provisioning state of the resource.
- Resource
Guid string - Unique identifier for this resource.
- System
Data Pulumi.Azure Native. Network. Outputs. System Data Response - The system metadata related to this resource.
- Type string
- Resource type.
- Azure
Api stringVersion - The Azure API version of the resource.
- Etag string
- A unique read-only string that changes whenever the resource is updated.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name.
- Provisioning
State string - The provisioning state of the resource.
- Resource
Guid string - Unique identifier for this resource.
- System
Data SystemData Response - The system metadata related to this resource.
- Type string
- Resource type.
- azure
Api StringVersion - The Azure API version of the resource.
- etag String
- A unique read-only string that changes whenever the resource is updated.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name.
- provisioning
State String - The provisioning state of the resource.
- resource
Guid String - Unique identifier for this resource.
- system
Data SystemData Response - The system metadata related to this resource.
- type String
- Resource type.
- azure
Api stringVersion - The Azure API version of the resource.
- etag string
- A unique read-only string that changes whenever the resource is updated.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Resource name.
- provisioning
State string - The provisioning state of the resource.
- resource
Guid string - Unique identifier for this resource.
- system
Data SystemData Response - The system metadata related to this resource.
- type string
- Resource type.
- azure_
api_ strversion - The Azure API version of the resource.
- etag str
- A unique read-only string that changes whenever the resource is updated.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Resource name.
- provisioning_
state str - The provisioning state of the resource.
- resource_
guid str - Unique identifier for this resource.
- system_
data SystemData Response - The system metadata related to this resource.
- type str
- Resource type.
- azure
Api StringVersion - The Azure API version of the resource.
- etag String
- A unique read-only string that changes whenever the resource is updated.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name.
- provisioning
State String - The provisioning state of the resource.
- resource
Guid String - Unique identifier for this resource.
- system
Data Property Map - The system metadata related to this resource.
- type String
- Resource type.
Supporting Types
RoutingRuleDestinationType, RoutingRuleDestinationTypeArgs
- Address
Prefix - AddressPrefix
- Service
Tag - ServiceTag
- Routing
Rule Destination Type Address Prefix - AddressPrefix
- Routing
Rule Destination Type Service Tag - ServiceTag
- Address
Prefix - AddressPrefix
- Service
Tag - ServiceTag
- Address
Prefix - AddressPrefix
- Service
Tag - ServiceTag
- ADDRESS_PREFIX
- AddressPrefix
- SERVICE_TAG
- ServiceTag
- "Address
Prefix" - AddressPrefix
- "Service
Tag" - ServiceTag
RoutingRuleNextHop, RoutingRuleNextHopArgs
- Next
Hop Type This property is required. string | Pulumi.Azure Native. Network. Routing Rule Next Hop Type - Next hop type.
- Next
Hop stringAddress - Next hop address. Only required if the next hop type is VirtualAppliance.
- Next
Hop Type This property is required. string | RoutingRule Next Hop Type - Next hop type.
- Next
Hop stringAddress - Next hop address. Only required if the next hop type is VirtualAppliance.
- next
Hop Type This property is required. String | RoutingRule Next Hop Type - Next hop type.
- next
Hop StringAddress - Next hop address. Only required if the next hop type is VirtualAppliance.
- next
Hop Type This property is required. string | RoutingRule Next Hop Type - Next hop type.
- next
Hop stringAddress - Next hop address. Only required if the next hop type is VirtualAppliance.
- next_
hop_ type This property is required. str | RoutingRule Next Hop Type - Next hop type.
- next_
hop_ straddress - Next hop address. Only required if the next hop type is VirtualAppliance.
- next
Hop Type This property is required. String | "Internet" | "NoNext Hop" | "Virtual Appliance" | "Virtual Network Gateway" | "Vnet Local" - Next hop type.
- next
Hop StringAddress - Next hop address. Only required if the next hop type is VirtualAppliance.
RoutingRuleNextHopResponse, RoutingRuleNextHopResponseArgs
- Next
Hop Type This property is required. string - Next hop type.
- Next
Hop stringAddress - Next hop address. Only required if the next hop type is VirtualAppliance.
- Next
Hop Type This property is required. string - Next hop type.
- Next
Hop stringAddress - Next hop address. Only required if the next hop type is VirtualAppliance.
- next
Hop Type This property is required. String - Next hop type.
- next
Hop StringAddress - Next hop address. Only required if the next hop type is VirtualAppliance.
- next
Hop Type This property is required. string - Next hop type.
- next
Hop stringAddress - Next hop address. Only required if the next hop type is VirtualAppliance.
- next_
hop_ type This property is required. str - Next hop type.
- next_
hop_ straddress - Next hop address. Only required if the next hop type is VirtualAppliance.
- next
Hop Type This property is required. String - Next hop type.
- next
Hop StringAddress - Next hop address. Only required if the next hop type is VirtualAppliance.
RoutingRuleNextHopType, RoutingRuleNextHopTypeArgs
- Internet
- Internet
- No
Next Hop - NoNextHop
- Virtual
Appliance - VirtualAppliance
- Virtual
Network Gateway - VirtualNetworkGateway
- Vnet
Local - VnetLocal
- Routing
Rule Next Hop Type Internet - Internet
- Routing
Rule Next Hop Type No Next Hop - NoNextHop
- Routing
Rule Next Hop Type Virtual Appliance - VirtualAppliance
- Routing
Rule Next Hop Type Virtual Network Gateway - VirtualNetworkGateway
- Routing
Rule Next Hop Type Vnet Local - VnetLocal
- Internet
- Internet
- No
Next Hop - NoNextHop
- Virtual
Appliance - VirtualAppliance
- Virtual
Network Gateway - VirtualNetworkGateway
- Vnet
Local - VnetLocal
- Internet
- Internet
- No
Next Hop - NoNextHop
- Virtual
Appliance - VirtualAppliance
- Virtual
Network Gateway - VirtualNetworkGateway
- Vnet
Local - VnetLocal
- INTERNET
- Internet
- NO_NEXT_HOP
- NoNextHop
- VIRTUAL_APPLIANCE
- VirtualAppliance
- VIRTUAL_NETWORK_GATEWAY
- VirtualNetworkGateway
- VNET_LOCAL
- VnetLocal
- "Internet"
- Internet
- "No
Next Hop" - NoNextHop
- "Virtual
Appliance" - VirtualAppliance
- "Virtual
Network Gateway" - VirtualNetworkGateway
- "Vnet
Local" - VnetLocal
RoutingRuleRouteDestination, RoutingRuleRouteDestinationArgs
- Destination
Address This property is required. string - Destination address.
- Type
This property is required. string | Pulumi.Azure Native. Network. Routing Rule Destination Type - Destination type.
- Destination
Address This property is required. string - Destination address.
- Type
This property is required. string | RoutingRule Destination Type - Destination type.
- destination
Address This property is required. String - Destination address.
- type
This property is required. String | RoutingRule Destination Type - Destination type.
- destination
Address This property is required. string - Destination address.
- type
This property is required. string | RoutingRule Destination Type - Destination type.
- destination_
address This property is required. str - Destination address.
- type
This property is required. str | RoutingRule Destination Type - Destination type.
- destination
Address This property is required. String - Destination address.
- type
This property is required. String | "AddressPrefix" | "Service Tag" - Destination type.
RoutingRuleRouteDestinationResponse, RoutingRuleRouteDestinationResponseArgs
- Destination
Address This property is required. string - Destination address.
- Type
This property is required. string - Destination type.
- Destination
Address This property is required. string - Destination address.
- Type
This property is required. string - Destination type.
- destination
Address This property is required. String - Destination address.
- type
This property is required. String - Destination type.
- destination
Address This property is required. string - Destination address.
- type
This property is required. string - Destination type.
- destination_
address This property is required. str - Destination address.
- type
This property is required. str - Destination type.
- destination
Address This property is required. String - Destination address.
- type
This property is required. String - Destination type.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The type of identity that last modified the resource.
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The type of identity that last modified the resource.
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The type of identity that last modified the resource.
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The type of identity that last modified the resource.
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The type of identity that last modified the resource.
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The type of identity that last modified the resource.
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:network:RoutingRule SampleRoutingRule /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0