azure-native.network.HubRouteTable
Explore with Pulumi AI
RouteTable resource in a virtual hub.
Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.
Other available API versions: 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 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 HubRouteTable Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new HubRouteTable(name: string, args: HubRouteTableArgs, opts?: CustomResourceOptions);
@overload
def HubRouteTable(resource_name: str,
args: HubRouteTableArgs,
opts: Optional[ResourceOptions] = None)
@overload
def HubRouteTable(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
virtual_hub_name: Optional[str] = None,
id: Optional[str] = None,
labels: Optional[Sequence[str]] = None,
name: Optional[str] = None,
route_table_name: Optional[str] = None,
routes: Optional[Sequence[HubRouteArgs]] = None)
func NewHubRouteTable(ctx *Context, name string, args HubRouteTableArgs, opts ...ResourceOption) (*HubRouteTable, error)
public HubRouteTable(string name, HubRouteTableArgs args, CustomResourceOptions? opts = null)
public HubRouteTable(String name, HubRouteTableArgs args)
public HubRouteTable(String name, HubRouteTableArgs args, CustomResourceOptions options)
type: azure-native:network:HubRouteTable
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. HubRouteTableArgs - 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. HubRouteTableArgs - 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. HubRouteTableArgs - 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. HubRouteTableArgs - 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. HubRouteTableArgs - 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 hubRouteTableResource = new AzureNative.Network.HubRouteTable("hubRouteTableResource", new()
{
ResourceGroupName = "string",
VirtualHubName = "string",
Id = "string",
Labels = new[]
{
"string",
},
Name = "string",
RouteTableName = "string",
Routes = new[]
{
new AzureNative.Network.Inputs.HubRouteArgs
{
DestinationType = "string",
Destinations = new[]
{
"string",
},
Name = "string",
NextHop = "string",
NextHopType = "string",
},
},
});
example, err := network.NewHubRouteTable(ctx, "hubRouteTableResource", &network.HubRouteTableArgs{
ResourceGroupName: pulumi.String("string"),
VirtualHubName: pulumi.String("string"),
Id: pulumi.String("string"),
Labels: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
RouteTableName: pulumi.String("string"),
Routes: network.HubRouteArray{
&network.HubRouteArgs{
DestinationType: pulumi.String("string"),
Destinations: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
NextHop: pulumi.String("string"),
NextHopType: pulumi.String("string"),
},
},
})
var hubRouteTableResource = new HubRouteTable("hubRouteTableResource", HubRouteTableArgs.builder()
.resourceGroupName("string")
.virtualHubName("string")
.id("string")
.labels("string")
.name("string")
.routeTableName("string")
.routes(HubRouteArgs.builder()
.destinationType("string")
.destinations("string")
.name("string")
.nextHop("string")
.nextHopType("string")
.build())
.build());
hub_route_table_resource = azure_native.network.HubRouteTable("hubRouteTableResource",
resource_group_name="string",
virtual_hub_name="string",
id="string",
labels=["string"],
name="string",
route_table_name="string",
routes=[{
"destination_type": "string",
"destinations": ["string"],
"name": "string",
"next_hop": "string",
"next_hop_type": "string",
}])
const hubRouteTableResource = new azure_native.network.HubRouteTable("hubRouteTableResource", {
resourceGroupName: "string",
virtualHubName: "string",
id: "string",
labels: ["string"],
name: "string",
routeTableName: "string",
routes: [{
destinationType: "string",
destinations: ["string"],
name: "string",
nextHop: "string",
nextHopType: "string",
}],
});
type: azure-native:network:HubRouteTable
properties:
id: string
labels:
- string
name: string
resourceGroupName: string
routeTableName: string
routes:
- destinationType: string
destinations:
- string
name: string
nextHop: string
nextHopType: string
virtualHubName: string
HubRouteTable 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 HubRouteTable resource accepts the following input properties:
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group name of the VirtualHub.
- Virtual
Hub Name This property is required. Changes to this property will trigger replacement.
- The name of the VirtualHub.
- Id string
- Resource ID.
- Labels List<string>
- List of labels associated with this route table.
- Name string
- The name of the resource that is unique within a resource group. This name can be used to access the resource.
- Route
Table Name Changes to this property will trigger replacement.
- The name of the RouteTable.
- Routes
List<Pulumi.
Azure Native. Network. Inputs. Hub Route> - List of all routes.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group name of the VirtualHub.
- Virtual
Hub Name This property is required. Changes to this property will trigger replacement.
- The name of the VirtualHub.
- Id string
- Resource ID.
- Labels []string
- List of labels associated with this route table.
- Name string
- The name of the resource that is unique within a resource group. This name can be used to access the resource.
- Route
Table Name Changes to this property will trigger replacement.
- The name of the RouteTable.
- Routes
[]Hub
Route Args - List of all routes.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group name of the VirtualHub.
- virtual
Hub Name This property is required. Changes to this property will trigger replacement.
- The name of the VirtualHub.
- id String
- Resource ID.
- labels List<String>
- List of labels associated with this route table.
- name String
- The name of the resource that is unique within a resource group. This name can be used to access the resource.
- route
Table Name Changes to this property will trigger replacement.
- The name of the RouteTable.
- routes
List<Hub
Route> - List of all routes.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group name of the VirtualHub.
- virtual
Hub Name This property is required. Changes to this property will trigger replacement.
- The name of the VirtualHub.
- id string
- Resource ID.
- labels string[]
- List of labels associated with this route table.
- name string
- The name of the resource that is unique within a resource group. This name can be used to access the resource.
- route
Table Name Changes to this property will trigger replacement.
- The name of the RouteTable.
- routes
Hub
Route[] - List of all routes.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The resource group name of the VirtualHub.
- virtual_
hub_ name This property is required. Changes to this property will trigger replacement.
- The name of the VirtualHub.
- id str
- Resource ID.
- labels Sequence[str]
- List of labels associated with this route table.
- name str
- The name of the resource that is unique within a resource group. This name can be used to access the resource.
- route_
table_ name Changes to this property will trigger replacement.
- The name of the RouteTable.
- routes
Sequence[Hub
Route Args] - List of all routes.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group name of the VirtualHub.
- virtual
Hub Name This property is required. Changes to this property will trigger replacement.
- The name of the VirtualHub.
- id String
- Resource ID.
- labels List<String>
- List of labels associated with this route table.
- name String
- The name of the resource that is unique within a resource group. This name can be used to access the resource.
- route
Table Name Changes to this property will trigger replacement.
- The name of the RouteTable.
- routes List<Property Map>
- List of all routes.
Outputs
All input properties are implicitly available as output properties. Additionally, the HubRouteTable resource produces the following output properties:
- Associated
Connections List<string> - List of all connections associated with this route table.
- 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.
- Propagating
Connections List<string> - List of all connections that advertise to this route table.
- Provisioning
State string - The provisioning state of the RouteTable resource.
- Type string
- Resource type.
- Associated
Connections []string - List of all connections associated with this route table.
- 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.
- Propagating
Connections []string - List of all connections that advertise to this route table.
- Provisioning
State string - The provisioning state of the RouteTable resource.
- Type string
- Resource type.
- associated
Connections List<String> - List of all connections associated with this route table.
- 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.
- propagating
Connections List<String> - List of all connections that advertise to this route table.
- provisioning
State String - The provisioning state of the RouteTable resource.
- type String
- Resource type.
- associated
Connections string[] - List of all connections associated with this route table.
- 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.
- propagating
Connections string[] - List of all connections that advertise to this route table.
- provisioning
State string - The provisioning state of the RouteTable resource.
- type string
- Resource type.
- associated_
connections Sequence[str] - List of all connections associated with this route table.
- 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.
- propagating_
connections Sequence[str] - List of all connections that advertise to this route table.
- provisioning_
state str - The provisioning state of the RouteTable resource.
- type str
- Resource type.
- associated
Connections List<String> - List of all connections associated with this route table.
- 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.
- propagating
Connections List<String> - List of all connections that advertise to this route table.
- provisioning
State String - The provisioning state of the RouteTable resource.
- type String
- Resource type.
Supporting Types
HubRoute, HubRouteArgs
- Destination
Type This property is required. string - The type of destinations (eg: CIDR, ResourceId, Service).
- Destinations
This property is required. List<string> - List of all destinations.
- Name
This property is required. string - The name of the Route that is unique within a RouteTable. This name can be used to access this route.
- Next
Hop This property is required. string - NextHop resource ID.
- Next
Hop Type This property is required. string - The type of next hop (eg: ResourceId).
- Destination
Type This property is required. string - The type of destinations (eg: CIDR, ResourceId, Service).
- Destinations
This property is required. []string - List of all destinations.
- Name
This property is required. string - The name of the Route that is unique within a RouteTable. This name can be used to access this route.
- Next
Hop This property is required. string - NextHop resource ID.
- Next
Hop Type This property is required. string - The type of next hop (eg: ResourceId).
- destination
Type This property is required. String - The type of destinations (eg: CIDR, ResourceId, Service).
- destinations
This property is required. List<String> - List of all destinations.
- name
This property is required. String - The name of the Route that is unique within a RouteTable. This name can be used to access this route.
- next
Hop This property is required. String - NextHop resource ID.
- next
Hop Type This property is required. String - The type of next hop (eg: ResourceId).
- destination
Type This property is required. string - The type of destinations (eg: CIDR, ResourceId, Service).
- destinations
This property is required. string[] - List of all destinations.
- name
This property is required. string - The name of the Route that is unique within a RouteTable. This name can be used to access this route.
- next
Hop This property is required. string - NextHop resource ID.
- next
Hop Type This property is required. string - The type of next hop (eg: ResourceId).
- destination_
type This property is required. str - The type of destinations (eg: CIDR, ResourceId, Service).
- destinations
This property is required. Sequence[str] - List of all destinations.
- name
This property is required. str - The name of the Route that is unique within a RouteTable. This name can be used to access this route.
- next_
hop This property is required. str - NextHop resource ID.
- next_
hop_ type This property is required. str - The type of next hop (eg: ResourceId).
- destination
Type This property is required. String - The type of destinations (eg: CIDR, ResourceId, Service).
- destinations
This property is required. List<String> - List of all destinations.
- name
This property is required. String - The name of the Route that is unique within a RouteTable. This name can be used to access this route.
- next
Hop This property is required. String - NextHop resource ID.
- next
Hop Type This property is required. String - The type of next hop (eg: ResourceId).
HubRouteResponse, HubRouteResponseArgs
- Destination
Type This property is required. string - The type of destinations (eg: CIDR, ResourceId, Service).
- Destinations
This property is required. List<string> - List of all destinations.
- Name
This property is required. string - The name of the Route that is unique within a RouteTable. This name can be used to access this route.
- Next
Hop This property is required. string - NextHop resource ID.
- Next
Hop Type This property is required. string - The type of next hop (eg: ResourceId).
- Destination
Type This property is required. string - The type of destinations (eg: CIDR, ResourceId, Service).
- Destinations
This property is required. []string - List of all destinations.
- Name
This property is required. string - The name of the Route that is unique within a RouteTable. This name can be used to access this route.
- Next
Hop This property is required. string - NextHop resource ID.
- Next
Hop Type This property is required. string - The type of next hop (eg: ResourceId).
- destination
Type This property is required. String - The type of destinations (eg: CIDR, ResourceId, Service).
- destinations
This property is required. List<String> - List of all destinations.
- name
This property is required. String - The name of the Route that is unique within a RouteTable. This name can be used to access this route.
- next
Hop This property is required. String - NextHop resource ID.
- next
Hop Type This property is required. String - The type of next hop (eg: ResourceId).
- destination
Type This property is required. string - The type of destinations (eg: CIDR, ResourceId, Service).
- destinations
This property is required. string[] - List of all destinations.
- name
This property is required. string - The name of the Route that is unique within a RouteTable. This name can be used to access this route.
- next
Hop This property is required. string - NextHop resource ID.
- next
Hop Type This property is required. string - The type of next hop (eg: ResourceId).
- destination_
type This property is required. str - The type of destinations (eg: CIDR, ResourceId, Service).
- destinations
This property is required. Sequence[str] - List of all destinations.
- name
This property is required. str - The name of the Route that is unique within a RouteTable. This name can be used to access this route.
- next_
hop This property is required. str - NextHop resource ID.
- next_
hop_ type This property is required. str - The type of next hop (eg: ResourceId).
- destination
Type This property is required. String - The type of destinations (eg: CIDR, ResourceId, Service).
- destinations
This property is required. List<String> - List of all destinations.
- name
This property is required. String - The name of the Route that is unique within a RouteTable. This name can be used to access this route.
- next
Hop This property is required. String - NextHop resource ID.
- next
Hop Type This property is required. String - The type of next hop (eg: ResourceId).
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:network:HubRouteTable hubRouteTable1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables/{routeTableName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0