Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. networkconnectivity
  5. networkconnectivity/v1
  6. getPolicyBasedRoute

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.networkconnectivity/v1.getPolicyBasedRoute

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets details of a single policy-based route.

    Using getPolicyBasedRoute

    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 getPolicyBasedRoute(args: GetPolicyBasedRouteArgs, opts?: InvokeOptions): Promise<GetPolicyBasedRouteResult>
function getPolicyBasedRouteOutput(args: GetPolicyBasedRouteOutputArgs, opts?: InvokeOptions): Output<GetPolicyBasedRouteResult>
    def get_policy_based_route(policy_based_route_id: Optional[str] = None,
                           project: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPolicyBasedRouteResult
def get_policy_based_route_output(policy_based_route_id: Optional[pulumi.Input[str]] = None,
                           project: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPolicyBasedRouteResult]
    func LookupPolicyBasedRoute(ctx *Context, args *LookupPolicyBasedRouteArgs, opts ...InvokeOption) (*LookupPolicyBasedRouteResult, error)
func LookupPolicyBasedRouteOutput(ctx *Context, args *LookupPolicyBasedRouteOutputArgs, opts ...InvokeOption) LookupPolicyBasedRouteResultOutput

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

    public static class GetPolicyBasedRoute 
{
    public static Task<GetPolicyBasedRouteResult> InvokeAsync(GetPolicyBasedRouteArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyBasedRouteResult> Invoke(GetPolicyBasedRouteInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPolicyBasedRouteResult> getPolicyBasedRoute(GetPolicyBasedRouteArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:networkconnectivity/v1:getPolicyBasedRoute
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getPolicyBasedRoute Result

    The following output properties are available:

    CreateTime string
    Time when the policy-based route was created.
    Description string
    Optional. An optional description of this resource. Provide this field when you create the resource.
    Filter Pulumi.GoogleNative.NetworkConnectivity.V1.Outputs.FilterResponse
    The filter to match L4 traffic.
    InterconnectAttachment Pulumi.GoogleNative.NetworkConnectivity.V1.Outputs.InterconnectAttachmentResponse
    Optional. The interconnect attachments that this policy-based route applies to.
    Kind string
    Type of this resource. Always networkconnectivity#policyBasedRoute for policy-based Route resources.
    Labels Dictionary<string, string>
    User-defined labels.
    Name string
    Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}
    Network string
    Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.
    NextHopIlbIp string
    Optional. The IP address of a global-access-enabled L4 ILB that is the next hop for matching packets. For this version, only nextHopIlbIp is supported.
    NextHopOtherRoutes string
    Optional. Other routes that will be referenced to determine the next hop of the packet.
    Priority int
    Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive.
    SelfLink string
    Server-defined fully-qualified URL for this resource.
    UpdateTime string
    Time when the policy-based route was updated.
    VirtualMachine Pulumi.GoogleNative.NetworkConnectivity.V1.Outputs.VirtualMachineResponse
    Optional. VM instances to which this policy-based route applies to.
    Warnings List<Pulumi.GoogleNative.NetworkConnectivity.V1.Outputs.WarningsResponse>
    If potential misconfigurations are detected for this route, this field will be populated with warning messages.
    CreateTime string
    Time when the policy-based route was created.
    Description string
    Optional. An optional description of this resource. Provide this field when you create the resource.
    Filter FilterResponse
    The filter to match L4 traffic.
    InterconnectAttachment InterconnectAttachmentResponse
    Optional. The interconnect attachments that this policy-based route applies to.
    Kind string
    Type of this resource. Always networkconnectivity#policyBasedRoute for policy-based Route resources.
    Labels map[string]string
    User-defined labels.
    Name string
    Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}
    Network string
    Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.
    NextHopIlbIp string
    Optional. The IP address of a global-access-enabled L4 ILB that is the next hop for matching packets. For this version, only nextHopIlbIp is supported.
    NextHopOtherRoutes string
    Optional. Other routes that will be referenced to determine the next hop of the packet.
    Priority int
    Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive.
    SelfLink string
    Server-defined fully-qualified URL for this resource.
    UpdateTime string
    Time when the policy-based route was updated.
    VirtualMachine VirtualMachineResponse
    Optional. VM instances to which this policy-based route applies to.
    Warnings []WarningsResponse
    If potential misconfigurations are detected for this route, this field will be populated with warning messages.
    createTime String
    Time when the policy-based route was created.
    description String
    Optional. An optional description of this resource. Provide this field when you create the resource.
    filter FilterResponse
    The filter to match L4 traffic.
    interconnectAttachment InterconnectAttachmentResponse
    Optional. The interconnect attachments that this policy-based route applies to.
    kind String
    Type of this resource. Always networkconnectivity#policyBasedRoute for policy-based Route resources.
    labels Map<String,String>
    User-defined labels.
    name String
    Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}
    network String
    Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.
    nextHopIlbIp String
    Optional. The IP address of a global-access-enabled L4 ILB that is the next hop for matching packets. For this version, only nextHopIlbIp is supported.
    nextHopOtherRoutes String
    Optional. Other routes that will be referenced to determine the next hop of the packet.
    priority Integer
    Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive.
    selfLink String
    Server-defined fully-qualified URL for this resource.
    updateTime String
    Time when the policy-based route was updated.
    virtualMachine VirtualMachineResponse
    Optional. VM instances to which this policy-based route applies to.
    warnings List<WarningsResponse>
    If potential misconfigurations are detected for this route, this field will be populated with warning messages.
    createTime string
    Time when the policy-based route was created.
    description string
    Optional. An optional description of this resource. Provide this field when you create the resource.
    filter FilterResponse
    The filter to match L4 traffic.
    interconnectAttachment InterconnectAttachmentResponse
    Optional. The interconnect attachments that this policy-based route applies to.
    kind string
    Type of this resource. Always networkconnectivity#policyBasedRoute for policy-based Route resources.
    labels {[key: string]: string}
    User-defined labels.
    name string
    Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}
    network string
    Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.
    nextHopIlbIp string
    Optional. The IP address of a global-access-enabled L4 ILB that is the next hop for matching packets. For this version, only nextHopIlbIp is supported.
    nextHopOtherRoutes string
    Optional. Other routes that will be referenced to determine the next hop of the packet.
    priority number
    Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive.
    selfLink string
    Server-defined fully-qualified URL for this resource.
    updateTime string
    Time when the policy-based route was updated.
    virtualMachine VirtualMachineResponse
    Optional. VM instances to which this policy-based route applies to.
    warnings WarningsResponse[]
    If potential misconfigurations are detected for this route, this field will be populated with warning messages.
    create_time str
    Time when the policy-based route was created.
    description str
    Optional. An optional description of this resource. Provide this field when you create the resource.
    filter FilterResponse
    The filter to match L4 traffic.
    interconnect_attachment InterconnectAttachmentResponse
    Optional. The interconnect attachments that this policy-based route applies to.
    kind str
    Type of this resource. Always networkconnectivity#policyBasedRoute for policy-based Route resources.
    labels Mapping[str, str]
    User-defined labels.
    name str
    Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}
    network str
    Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.
    next_hop_ilb_ip str
    Optional. The IP address of a global-access-enabled L4 ILB that is the next hop for matching packets. For this version, only nextHopIlbIp is supported.
    next_hop_other_routes str
    Optional. Other routes that will be referenced to determine the next hop of the packet.
    priority int
    Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive.
    self_link str
    Server-defined fully-qualified URL for this resource.
    update_time str
    Time when the policy-based route was updated.
    virtual_machine VirtualMachineResponse
    Optional. VM instances to which this policy-based route applies to.
    warnings Sequence[WarningsResponse]
    If potential misconfigurations are detected for this route, this field will be populated with warning messages.
    createTime String
    Time when the policy-based route was created.
    description String
    Optional. An optional description of this resource. Provide this field when you create the resource.
    filter Property Map
    The filter to match L4 traffic.
    interconnectAttachment Property Map
    Optional. The interconnect attachments that this policy-based route applies to.
    kind String
    Type of this resource. Always networkconnectivity#policyBasedRoute for policy-based Route resources.
    labels Map<String>
    User-defined labels.
    name String
    Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}
    network String
    Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.
    nextHopIlbIp String
    Optional. The IP address of a global-access-enabled L4 ILB that is the next hop for matching packets. For this version, only nextHopIlbIp is supported.
    nextHopOtherRoutes String
    Optional. Other routes that will be referenced to determine the next hop of the packet.
    priority Number
    Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive.
    selfLink String
    Server-defined fully-qualified URL for this resource.
    updateTime String
    Time when the policy-based route was updated.
    virtualMachine Property Map
    Optional. VM instances to which this policy-based route applies to.
    warnings List<Property Map>
    If potential misconfigurations are detected for this route, this field will be populated with warning messages.

    Supporting Types

    FilterResponse

    DestRange string
    Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
    IpProtocol string
    Optional. The IP protocol that this policy-based route applies to. Valid values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'.
    ProtocolVersion string
    Internet protocol versions this policy-based route applies to. For this version, only IPV4 is supported.
    SrcRange string
    Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
    DestRange string
    Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
    IpProtocol string
    Optional. The IP protocol that this policy-based route applies to. Valid values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'.
    ProtocolVersion string
    Internet protocol versions this policy-based route applies to. For this version, only IPV4 is supported.
    SrcRange string
    Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
    destRange String
    Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
    ipProtocol String
    Optional. The IP protocol that this policy-based route applies to. Valid values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'.
    protocolVersion String
    Internet protocol versions this policy-based route applies to. For this version, only IPV4 is supported.
    srcRange String
    Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
    destRange string
    Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
    ipProtocol string
    Optional. The IP protocol that this policy-based route applies to. Valid values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'.
    protocolVersion string
    Internet protocol versions this policy-based route applies to. For this version, only IPV4 is supported.
    srcRange string
    Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
    dest_range str
    Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
    ip_protocol str
    Optional. The IP protocol that this policy-based route applies to. Valid values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'.
    protocol_version str
    Internet protocol versions this policy-based route applies to. For this version, only IPV4 is supported.
    src_range str
    Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
    destRange String
    Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
    ipProtocol String
    Optional. The IP protocol that this policy-based route applies to. Valid values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'.
    protocolVersion String
    Internet protocol versions this policy-based route applies to. For this version, only IPV4 is supported.
    srcRange String
    Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.

    InterconnectAttachmentResponse

    Region string
    Optional. Cloud region to install this policy-based route on interconnect attachment. Use all to install it on all interconnect attachments.
    Region string
    Optional. Cloud region to install this policy-based route on interconnect attachment. Use all to install it on all interconnect attachments.
    region String
    Optional. Cloud region to install this policy-based route on interconnect attachment. Use all to install it on all interconnect attachments.
    region string
    Optional. Cloud region to install this policy-based route on interconnect attachment. Use all to install it on all interconnect attachments.
    region str
    Optional. Cloud region to install this policy-based route on interconnect attachment. Use all to install it on all interconnect attachments.
    region String
    Optional. Cloud region to install this policy-based route on interconnect attachment. Use all to install it on all interconnect attachments.

    VirtualMachineResponse

    Tags List<string>
    Optional. A list of VM instance tags the this policy-based route applies to. VM instances that have ANY of tags specified here will install this PBR.
    Tags []string
    Optional. A list of VM instance tags the this policy-based route applies to. VM instances that have ANY of tags specified here will install this PBR.
    tags List<String>
    Optional. A list of VM instance tags the this policy-based route applies to. VM instances that have ANY of tags specified here will install this PBR.
    tags string[]
    Optional. A list of VM instance tags the this policy-based route applies to. VM instances that have ANY of tags specified here will install this PBR.
    tags Sequence[str]
    Optional. A list of VM instance tags the this policy-based route applies to. VM instances that have ANY of tags specified here will install this PBR.
    tags List<String>
    Optional. A list of VM instance tags the this policy-based route applies to. VM instances that have ANY of tags specified here will install this PBR.

    WarningsResponse

    Code string
    A warning code, if applicable.
    Data Dictionary<string, string>
    Metadata about this warning in key: value format. The key should provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement.
    WarningMessage string
    A human-readable description of the warning code.
    Code string
    A warning code, if applicable.
    Data map[string]string
    Metadata about this warning in key: value format. The key should provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement.
    WarningMessage string
    A human-readable description of the warning code.
    code String
    A warning code, if applicable.
    data Map<String,String>
    Metadata about this warning in key: value format. The key should provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement.
    warningMessage String
    A human-readable description of the warning code.
    code string
    A warning code, if applicable.
    data {[key: string]: string}
    Metadata about this warning in key: value format. The key should provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement.
    warningMessage string
    A human-readable description of the warning code.
    code str
    A warning code, if applicable.
    data Mapping[str, str]
    Metadata about this warning in key: value format. The key should provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement.
    warning_message str
    A human-readable description of the warning code.
    code String
    A warning code, if applicable.
    data Map<String>
    Metadata about this warning in key: value format. The key should provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement.
    warningMessage String
    A human-readable description of the warning code.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native