Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getVirtualRouter
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getVirtualRouter

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the specified Virtual Router.

    Uses Azure REST API version 2024-05-01.

    Other available API versions: 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 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.

    Using getVirtualRouter

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVirtualRouter(args: GetVirtualRouterArgs, opts?: InvokeOptions): Promise<GetVirtualRouterResult>
function getVirtualRouterOutput(args: GetVirtualRouterOutputArgs, opts?: InvokeOptions): Output<GetVirtualRouterResult>
    def get_virtual_router(expand: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       virtual_router_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetVirtualRouterResult
def get_virtual_router_output(expand: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       virtual_router_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetVirtualRouterResult]
    func LookupVirtualRouter(ctx *Context, args *LookupVirtualRouterArgs, opts ...InvokeOption) (*LookupVirtualRouterResult, error)
func LookupVirtualRouterOutput(ctx *Context, args *LookupVirtualRouterOutputArgs, opts ...InvokeOption) LookupVirtualRouterResultOutput

    > Note: This function is named LookupVirtualRouter in the Go SDK.

    public static class GetVirtualRouter 
{
    public static Task<GetVirtualRouterResult> InvokeAsync(GetVirtualRouterArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualRouterResult> Invoke(GetVirtualRouterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVirtualRouterResult> getVirtualRouter(GetVirtualRouterArgs args, InvokeOptions options)
public static Output<GetVirtualRouterResult> getVirtualRouter(GetVirtualRouterArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:network:getVirtualRouter
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group.
    VirtualRouterName string
    The name of the Virtual Router.
    Expand string
    Expands referenced resources.
    ResourceGroupName string
    The name of the resource group.
    VirtualRouterName string
    The name of the Virtual Router.
    Expand string
    Expands referenced resources.
    resourceGroupName String
    The name of the resource group.
    virtualRouterName String
    The name of the Virtual Router.
    expand String
    Expands referenced resources.
    resourceGroupName string
    The name of the resource group.
    virtualRouterName string
    The name of the Virtual Router.
    expand string
    Expands referenced resources.
    resource_group_name str
    The name of the resource group.
    virtual_router_name str
    The name of the Virtual Router.
    expand str
    Expands referenced resources.
    resourceGroupName String
    The name of the resource group.
    virtualRouterName String
    The name of the Virtual Router.
    expand String
    Expands referenced resources.

    getVirtualRouter Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Name string
    Resource name.
    Peerings List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
    List of references to VirtualRouterPeerings.
    ProvisioningState string
    The provisioning state of the resource.
    Type string
    Resource type.
    HostedGateway Pulumi.AzureNative.Network.Outputs.SubResourceResponse
    The Gateway on which VirtualRouter is hosted.
    HostedSubnet Pulumi.AzureNative.Network.Outputs.SubResourceResponse
    The Subnet on which VirtualRouter is hosted.
    Id string
    Resource ID.
    Location string
    Resource location.
    Tags Dictionary<string, string>
    Resource tags.
    VirtualRouterAsn double
    VirtualRouter ASN.
    VirtualRouterIps List<string>
    VirtualRouter IPs.
    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Name string
    Resource name.
    Peerings []SubResourceResponse
    List of references to VirtualRouterPeerings.
    ProvisioningState string
    The provisioning state of the resource.
    Type string
    Resource type.
    HostedGateway SubResourceResponse
    The Gateway on which VirtualRouter is hosted.
    HostedSubnet SubResourceResponse
    The Subnet on which VirtualRouter is hosted.
    Id string
    Resource ID.
    Location string
    Resource location.
    Tags map[string]string
    Resource tags.
    VirtualRouterAsn float64
    VirtualRouter ASN.
    VirtualRouterIps []string
    VirtualRouter IPs.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    name String
    Resource name.
    peerings List<SubResourceResponse>
    List of references to VirtualRouterPeerings.
    provisioningState String
    The provisioning state of the resource.
    type String
    Resource type.
    hostedGateway SubResourceResponse
    The Gateway on which VirtualRouter is hosted.
    hostedSubnet SubResourceResponse
    The Subnet on which VirtualRouter is hosted.
    id String
    Resource ID.
    location String
    Resource location.
    tags Map<String,String>
    Resource tags.
    virtualRouterAsn Double
    VirtualRouter ASN.
    virtualRouterIps List<String>
    VirtualRouter IPs.
    azureApiVersion string
    The Azure API version of the resource.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    name string
    Resource name.
    peerings SubResourceResponse[]
    List of references to VirtualRouterPeerings.
    provisioningState string
    The provisioning state of the resource.
    type string
    Resource type.
    hostedGateway SubResourceResponse
    The Gateway on which VirtualRouter is hosted.
    hostedSubnet SubResourceResponse
    The Subnet on which VirtualRouter is hosted.
    id string
    Resource ID.
    location string
    Resource location.
    tags {[key: string]: string}
    Resource tags.
    virtualRouterAsn number
    VirtualRouter ASN.
    virtualRouterIps string[]
    VirtualRouter IPs.
    azure_api_version str
    The Azure API version of the resource.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    name str
    Resource name.
    peerings Sequence[SubResourceResponse]
    List of references to VirtualRouterPeerings.
    provisioning_state str
    The provisioning state of the resource.
    type str
    Resource type.
    hosted_gateway SubResourceResponse
    The Gateway on which VirtualRouter is hosted.
    hosted_subnet SubResourceResponse
    The Subnet on which VirtualRouter is hosted.
    id str
    Resource ID.
    location str
    Resource location.
    tags Mapping[str, str]
    Resource tags.
    virtual_router_asn float
    VirtualRouter ASN.
    virtual_router_ips Sequence[str]
    VirtualRouter IPs.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    name String
    Resource name.
    peerings List<Property Map>
    List of references to VirtualRouterPeerings.
    provisioningState String
    The provisioning state of the resource.
    type String
    Resource type.
    hostedGateway Property Map
    The Gateway on which VirtualRouter is hosted.
    hostedSubnet Property Map
    The Subnet on which VirtualRouter is hosted.
    id String
    Resource ID.
    location String
    Resource location.
    tags Map<String>
    Resource tags.
    virtualRouterAsn Number
    VirtualRouter ASN.
    virtualRouterIps List<String>
    VirtualRouter IPs.

    Supporting Types

    SubResourceResponse

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native