Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. vmwareengine
  5. vmwareengine/v1
  6. getExternalAccessRule

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.vmwareengine/v1.getExternalAccessRule

Explore with Pulumi AI

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 external access rule.

Using getExternalAccessRule

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 getExternalAccessRule(args: GetExternalAccessRuleArgs, opts?: InvokeOptions): Promise<GetExternalAccessRuleResult>
function getExternalAccessRuleOutput(args: GetExternalAccessRuleOutputArgs, opts?: InvokeOptions): Output<GetExternalAccessRuleResult>
Copy
def get_external_access_rule(external_access_rule_id: Optional[str] = None,
                             location: Optional[str] = None,
                             network_policy_id: Optional[str] = None,
                             project: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetExternalAccessRuleResult
def get_external_access_rule_output(external_access_rule_id: Optional[pulumi.Input[str]] = None,
                             location: Optional[pulumi.Input[str]] = None,
                             network_policy_id: Optional[pulumi.Input[str]] = None,
                             project: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetExternalAccessRuleResult]
Copy
func LookupExternalAccessRule(ctx *Context, args *LookupExternalAccessRuleArgs, opts ...InvokeOption) (*LookupExternalAccessRuleResult, error)
func LookupExternalAccessRuleOutput(ctx *Context, args *LookupExternalAccessRuleOutputArgs, opts ...InvokeOption) LookupExternalAccessRuleResultOutput
Copy

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

public static class GetExternalAccessRule 
{
    public static Task<GetExternalAccessRuleResult> InvokeAsync(GetExternalAccessRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalAccessRuleResult> Invoke(GetExternalAccessRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetExternalAccessRuleResult> getExternalAccessRule(GetExternalAccessRuleArgs args, InvokeOptions options)
public static Output<GetExternalAccessRuleResult> getExternalAccessRule(GetExternalAccessRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:vmwareengine/v1:getExternalAccessRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ExternalAccessRuleId This property is required. string
Location This property is required. string
NetworkPolicyId This property is required. string
Project string
ExternalAccessRuleId This property is required. string
Location This property is required. string
NetworkPolicyId This property is required. string
Project string
externalAccessRuleId This property is required. String
location This property is required. String
networkPolicyId This property is required. String
project String
externalAccessRuleId This property is required. string
location This property is required. string
networkPolicyId This property is required. string
project string
external_access_rule_id This property is required. str
location This property is required. str
network_policy_id This property is required. str
project str
externalAccessRuleId This property is required. String
location This property is required. String
networkPolicyId This property is required. String
project String

getExternalAccessRule Result

The following output properties are available:

Action string
The action that the external access rule performs.
CreateTime string
Creation time of this resource.
Description string
User-provided description for this external access rule.
DestinationIpRanges List<Pulumi.GoogleNative.VMwareEngine.V1.Outputs.IpRangeResponse>
If destination ranges are specified, the external access rule applies only to the traffic that has a destination IP address in these ranges. The specified IP addresses must have reserved external IP addresses in the scope of the parent network policy. To match all external IP addresses in the scope of the parent network policy, specify 0.0.0.0/0. To match a specific external IP address, specify it using the IpRange.external_address property.
DestinationPorts List<string>
A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all destination ports, specify ["0-65535"].
IpProtocol string
The IP protocol to which the external access rule applies. This value can be one of the following three protocol strings (not case-sensitive): tcp, udp, or icmp.
Name string
The resource name of this external access rule. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule
Priority int
External access rule priority, which determines the external access rule to use when multiple rules apply. If multiple rules have the same priority, their ordering is non-deterministic. If specific ordering is required, assign unique priorities to enforce such ordering. The external access rule priority is an integer from 100 to 4096, both inclusive. Lower integers indicate higher precedence. For example, a rule with priority 100 has higher precedence than a rule with priority 101.
SourceIpRanges List<Pulumi.GoogleNative.VMwareEngine.V1.Outputs.IpRangeResponse>
If source ranges are specified, the external access rule applies only to traffic that has a source IP address in these ranges. These ranges can either be expressed in the CIDR format or as an IP address. As only inbound rules are supported, ExternalAddress resources cannot be the source IP addresses of an external access rule. To match all source addresses, specify 0.0.0.0/0.
SourcePorts List<string>
A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all source ports, specify ["0-65535"].
State string
The state of the resource.
Uid string
System-generated unique identifier for the resource.
UpdateTime string
Last update time of this resource.
Action string
The action that the external access rule performs.
CreateTime string
Creation time of this resource.
Description string
User-provided description for this external access rule.
DestinationIpRanges []IpRangeResponse
If destination ranges are specified, the external access rule applies only to the traffic that has a destination IP address in these ranges. The specified IP addresses must have reserved external IP addresses in the scope of the parent network policy. To match all external IP addresses in the scope of the parent network policy, specify 0.0.0.0/0. To match a specific external IP address, specify it using the IpRange.external_address property.
DestinationPorts []string
A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all destination ports, specify ["0-65535"].
IpProtocol string
The IP protocol to which the external access rule applies. This value can be one of the following three protocol strings (not case-sensitive): tcp, udp, or icmp.
Name string
The resource name of this external access rule. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule
Priority int
External access rule priority, which determines the external access rule to use when multiple rules apply. If multiple rules have the same priority, their ordering is non-deterministic. If specific ordering is required, assign unique priorities to enforce such ordering. The external access rule priority is an integer from 100 to 4096, both inclusive. Lower integers indicate higher precedence. For example, a rule with priority 100 has higher precedence than a rule with priority 101.
SourceIpRanges []IpRangeResponse
If source ranges are specified, the external access rule applies only to traffic that has a source IP address in these ranges. These ranges can either be expressed in the CIDR format or as an IP address. As only inbound rules are supported, ExternalAddress resources cannot be the source IP addresses of an external access rule. To match all source addresses, specify 0.0.0.0/0.
SourcePorts []string
A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all source ports, specify ["0-65535"].
State string
The state of the resource.
Uid string
System-generated unique identifier for the resource.
UpdateTime string
Last update time of this resource.
action String
The action that the external access rule performs.
createTime String
Creation time of this resource.
description String
User-provided description for this external access rule.
destinationIpRanges List<IpRangeResponse>
If destination ranges are specified, the external access rule applies only to the traffic that has a destination IP address in these ranges. The specified IP addresses must have reserved external IP addresses in the scope of the parent network policy. To match all external IP addresses in the scope of the parent network policy, specify 0.0.0.0/0. To match a specific external IP address, specify it using the IpRange.external_address property.
destinationPorts List<String>
A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all destination ports, specify ["0-65535"].
ipProtocol String
The IP protocol to which the external access rule applies. This value can be one of the following three protocol strings (not case-sensitive): tcp, udp, or icmp.
name String
The resource name of this external access rule. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule
priority Integer
External access rule priority, which determines the external access rule to use when multiple rules apply. If multiple rules have the same priority, their ordering is non-deterministic. If specific ordering is required, assign unique priorities to enforce such ordering. The external access rule priority is an integer from 100 to 4096, both inclusive. Lower integers indicate higher precedence. For example, a rule with priority 100 has higher precedence than a rule with priority 101.
sourceIpRanges List<IpRangeResponse>
If source ranges are specified, the external access rule applies only to traffic that has a source IP address in these ranges. These ranges can either be expressed in the CIDR format or as an IP address. As only inbound rules are supported, ExternalAddress resources cannot be the source IP addresses of an external access rule. To match all source addresses, specify 0.0.0.0/0.
sourcePorts List<String>
A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all source ports, specify ["0-65535"].
state String
The state of the resource.
uid String
System-generated unique identifier for the resource.
updateTime String
Last update time of this resource.
action string
The action that the external access rule performs.
createTime string
Creation time of this resource.
description string
User-provided description for this external access rule.
destinationIpRanges IpRangeResponse[]
If destination ranges are specified, the external access rule applies only to the traffic that has a destination IP address in these ranges. The specified IP addresses must have reserved external IP addresses in the scope of the parent network policy. To match all external IP addresses in the scope of the parent network policy, specify 0.0.0.0/0. To match a specific external IP address, specify it using the IpRange.external_address property.
destinationPorts string[]
A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all destination ports, specify ["0-65535"].
ipProtocol string
The IP protocol to which the external access rule applies. This value can be one of the following three protocol strings (not case-sensitive): tcp, udp, or icmp.
name string
The resource name of this external access rule. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule
priority number
External access rule priority, which determines the external access rule to use when multiple rules apply. If multiple rules have the same priority, their ordering is non-deterministic. If specific ordering is required, assign unique priorities to enforce such ordering. The external access rule priority is an integer from 100 to 4096, both inclusive. Lower integers indicate higher precedence. For example, a rule with priority 100 has higher precedence than a rule with priority 101.
sourceIpRanges IpRangeResponse[]
If source ranges are specified, the external access rule applies only to traffic that has a source IP address in these ranges. These ranges can either be expressed in the CIDR format or as an IP address. As only inbound rules are supported, ExternalAddress resources cannot be the source IP addresses of an external access rule. To match all source addresses, specify 0.0.0.0/0.
sourcePorts string[]
A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all source ports, specify ["0-65535"].
state string
The state of the resource.
uid string
System-generated unique identifier for the resource.
updateTime string
Last update time of this resource.
action str
The action that the external access rule performs.
create_time str
Creation time of this resource.
description str
User-provided description for this external access rule.
destination_ip_ranges Sequence[IpRangeResponse]
If destination ranges are specified, the external access rule applies only to the traffic that has a destination IP address in these ranges. The specified IP addresses must have reserved external IP addresses in the scope of the parent network policy. To match all external IP addresses in the scope of the parent network policy, specify 0.0.0.0/0. To match a specific external IP address, specify it using the IpRange.external_address property.
destination_ports Sequence[str]
A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all destination ports, specify ["0-65535"].
ip_protocol str
The IP protocol to which the external access rule applies. This value can be one of the following three protocol strings (not case-sensitive): tcp, udp, or icmp.
name str
The resource name of this external access rule. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule
priority int
External access rule priority, which determines the external access rule to use when multiple rules apply. If multiple rules have the same priority, their ordering is non-deterministic. If specific ordering is required, assign unique priorities to enforce such ordering. The external access rule priority is an integer from 100 to 4096, both inclusive. Lower integers indicate higher precedence. For example, a rule with priority 100 has higher precedence than a rule with priority 101.
source_ip_ranges Sequence[IpRangeResponse]
If source ranges are specified, the external access rule applies only to traffic that has a source IP address in these ranges. These ranges can either be expressed in the CIDR format or as an IP address. As only inbound rules are supported, ExternalAddress resources cannot be the source IP addresses of an external access rule. To match all source addresses, specify 0.0.0.0/0.
source_ports Sequence[str]
A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all source ports, specify ["0-65535"].
state str
The state of the resource.
uid str
System-generated unique identifier for the resource.
update_time str
Last update time of this resource.
action String
The action that the external access rule performs.
createTime String
Creation time of this resource.
description String
User-provided description for this external access rule.
destinationIpRanges List<Property Map>
If destination ranges are specified, the external access rule applies only to the traffic that has a destination IP address in these ranges. The specified IP addresses must have reserved external IP addresses in the scope of the parent network policy. To match all external IP addresses in the scope of the parent network policy, specify 0.0.0.0/0. To match a specific external IP address, specify it using the IpRange.external_address property.
destinationPorts List<String>
A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all destination ports, specify ["0-65535"].
ipProtocol String
The IP protocol to which the external access rule applies. This value can be one of the following three protocol strings (not case-sensitive): tcp, udp, or icmp.
name String
The resource name of this external access rule. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule
priority Number
External access rule priority, which determines the external access rule to use when multiple rules apply. If multiple rules have the same priority, their ordering is non-deterministic. If specific ordering is required, assign unique priorities to enforce such ordering. The external access rule priority is an integer from 100 to 4096, both inclusive. Lower integers indicate higher precedence. For example, a rule with priority 100 has higher precedence than a rule with priority 101.
sourceIpRanges List<Property Map>
If source ranges are specified, the external access rule applies only to traffic that has a source IP address in these ranges. These ranges can either be expressed in the CIDR format or as an IP address. As only inbound rules are supported, ExternalAddress resources cannot be the source IP addresses of an external access rule. To match all source addresses, specify 0.0.0.0/0.
sourcePorts List<String>
A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all source ports, specify ["0-65535"].
state String
The state of the resource.
uid String
System-generated unique identifier for the resource.
updateTime String
Last update time of this resource.

Supporting Types

IpRangeResponse

ExternalAddress This property is required. string
The name of an ExternalAddress resource. The external address must have been reserved in the scope of this external access rule's parent network policy. Provide the external address name in the form of projects/{project}/locations/{location}/privateClouds/{private_cloud}/externalAddresses/{external_address}. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address.
IpAddress This property is required. string
A single IP address. For example: 10.0.0.5.
IpAddressRange This property is required. string
An IP address range in the CIDR format. For example: 10.0.0.0/24.
ExternalAddress This property is required. string
The name of an ExternalAddress resource. The external address must have been reserved in the scope of this external access rule's parent network policy. Provide the external address name in the form of projects/{project}/locations/{location}/privateClouds/{private_cloud}/externalAddresses/{external_address}. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address.
IpAddress This property is required. string
A single IP address. For example: 10.0.0.5.
IpAddressRange This property is required. string
An IP address range in the CIDR format. For example: 10.0.0.0/24.
externalAddress This property is required. String
The name of an ExternalAddress resource. The external address must have been reserved in the scope of this external access rule's parent network policy. Provide the external address name in the form of projects/{project}/locations/{location}/privateClouds/{private_cloud}/externalAddresses/{external_address}. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address.
ipAddress This property is required. String
A single IP address. For example: 10.0.0.5.
ipAddressRange This property is required. String
An IP address range in the CIDR format. For example: 10.0.0.0/24.
externalAddress This property is required. string
The name of an ExternalAddress resource. The external address must have been reserved in the scope of this external access rule's parent network policy. Provide the external address name in the form of projects/{project}/locations/{location}/privateClouds/{private_cloud}/externalAddresses/{external_address}. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address.
ipAddress This property is required. string
A single IP address. For example: 10.0.0.5.
ipAddressRange This property is required. string
An IP address range in the CIDR format. For example: 10.0.0.0/24.
external_address This property is required. str
The name of an ExternalAddress resource. The external address must have been reserved in the scope of this external access rule's parent network policy. Provide the external address name in the form of projects/{project}/locations/{location}/privateClouds/{private_cloud}/externalAddresses/{external_address}. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address.
ip_address This property is required. str
A single IP address. For example: 10.0.0.5.
ip_address_range This property is required. str
An IP address range in the CIDR format. For example: 10.0.0.0/24.
externalAddress This property is required. String
The name of an ExternalAddress resource. The external address must have been reserved in the scope of this external access rule's parent network policy. Provide the external address name in the form of projects/{project}/locations/{location}/privateClouds/{private_cloud}/externalAddresses/{external_address}. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address.
ipAddress This property is required. String
A single IP address. For example: 10.0.0.5.
ipAddressRange This property is required. String
An IP address range in the CIDR format. For example: 10.0.0.0/24.

Package Details

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

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