external_access_rules

Creates, updates, deletes, gets or lists an external_access_rules resource.

Overview

Name	`external_access_rules`
Type	Resource
Id	`google.vmwareengine.external_access_rules`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`name`	`string`	Output only. 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`
`action`	`string`	The action that the external access rule performs. (ACTION_UNSPECIFIED, ALLOW, DENY)
`createTime`	`string (google-datetime)`	Output only. Creation time of this resource.
`description`	`string`	User-provided description for this external access rule.
`destinationIpRanges`	`array`	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`	`array`	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`.
`priority`	`integer (int32)`	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`	`array`	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`	`array`	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`	Output only. The state of the resource. (STATE_UNSPECIFIED, ACTIVE, CREATING, UPDATING, DELETING)
`uid`	`string`	Output only. System-generated unique identifier for the resource.
`updateTime`	`string (google-datetime)`	Output only. Last update time of this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `networkPoliciesId`, `externalAccessRulesId`		Gets details of a single external access rule.
`list`	`select`	`projectsId`, `locationsId`, `networkPoliciesId`	`pageSize`, `filter`, `orderBy`, `pageToken`	Lists `ExternalAccessRule` resources in the specified network policy.
`create`	`insert`	`projectsId`, `locationsId`, `networkPoliciesId`	`validateOnly`, `requestId`, `externalAccessRuleId`	Creates a new external access rule in a given network policy.
`patch`	`update`	`projectsId`, `locationsId`, `networkPoliciesId`, `externalAccessRulesId`	`updateMask`, `requestId`, `validateOnly`	Updates the parameters of a single external access rule. Only fields specified in `update_mask` are applied.
`delete`	`delete`	`projectsId`, `locationsId`, `networkPoliciesId`, `externalAccessRulesId`	`requestId`	Deletes a single external access rule.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`externalAccessRulesId`	`string`
`locationsId`	`string`
`networkPoliciesId`	`string`
`projectsId`	`string`
`externalAccessRuleId`	`string`
`filter`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`requestId`	`string`
`updateMask`	`string (google-fieldmask)`
`validateOnly`	`boolean`

`SELECT` examples

get
list

Gets details of a single external access rule.

SELECT
name,
action,
createTime,
description,
destinationIpRanges,
destinationPorts,
ipProtocol,
priority,
sourceIpRanges,
sourcePorts,
state,
uid,
updateTime
FROM google.vmwareengine.external_access_rules
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND networkPoliciesId = '{{ networkPoliciesId }}' -- required
AND externalAccessRulesId = '{{ externalAccessRulesId }}' -- required
;

Lists ExternalAccessRule resources in the specified network policy.

SELECT
*
FROM google.vmwareengine.external_access_rules
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND networkPoliciesId = '{{ networkPoliciesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
;

`INSERT` examples

create
Manifest

Creates a new external access rule in a given network policy.

INSERT INTO google.vmwareengine.external_access_rules (
data__destinationPorts,
data__description,
data__destinationIpRanges,
data__action,
data__priority,
data__ipProtocol,
data__sourcePorts,
data__sourceIpRanges,
projectsId,
locationsId,
networkPoliciesId,
validateOnly,
requestId,
externalAccessRuleId
)
SELECT 
'{{ destinationPorts }}',
'{{ description }}',
'{{ destinationIpRanges }}',
'{{ action }}',
{{ priority }},
'{{ ipProtocol }}',
'{{ sourcePorts }}',
'{{ sourceIpRanges }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ networkPoliciesId }}',
'{{ validateOnly }}',
'{{ requestId }}',
'{{ externalAccessRuleId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: external_access_rules
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the external_access_rules resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the external_access_rules resource.
  - name: networkPoliciesId
    value: "{{ networkPoliciesId }}"
    description: Required parameter for the external_access_rules resource.
  - name: destinationPorts
    value:
      - "{{ destinationPorts }}"
    description: |
      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"]`.
  - name: description
    value: "{{ description }}"
    description: |
      User-provided description for this external access rule.
  - name: destinationIpRanges
    description: |
      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.
    value:
      - externalAddress: "{{ externalAddress }}"
        ipAddress: "{{ ipAddress }}"
        ipAddressRange: "{{ ipAddressRange }}"
  - name: action
    value: "{{ action }}"
    description: |
      The action that the external access rule performs.
    valid_values: ['ACTION_UNSPECIFIED', 'ALLOW', 'DENY']
  - name: priority
    value: {{ priority }}
    description: |
      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`.
  - name: ipProtocol
    value: "{{ ipProtocol }}"
    description: |
      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: sourcePorts
    value:
      - "{{ sourcePorts }}"
    description: |
      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"]`.
  - name: sourceIpRanges
    description: |
      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`.
    value:
      - externalAddress: "{{ externalAddress }}"
        ipAddress: "{{ ipAddress }}"
        ipAddressRange: "{{ ipAddressRange }}"
  - name: validateOnly
    value: {{ validateOnly }}
  - name: requestId
    value: "{{ requestId }}"
  - name: externalAccessRuleId
    value: "{{ externalAccessRuleId }}"

`UPDATE` examples

patch

Updates the parameters of a single external access rule. Only fields specified in update_mask are applied.

UPDATE google.vmwareengine.external_access_rules
SET 
data__destinationPorts = '{{ destinationPorts }}',
data__description = '{{ description }}',
data__destinationIpRanges = '{{ destinationIpRanges }}',
data__action = '{{ action }}',
data__priority = {{ priority }},
data__ipProtocol = '{{ ipProtocol }}',
data__sourcePorts = '{{ sourcePorts }}',
data__sourceIpRanges = '{{ sourceIpRanges }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND networkPoliciesId = '{{ networkPoliciesId }}' --required
AND externalAccessRulesId = '{{ externalAccessRulesId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

delete

Deletes a single external access rule.

DELETE FROM google.vmwareengine.external_access_rules
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND networkPoliciesId = '{{ networkPoliciesId }}' --required
AND externalAccessRulesId = '{{ externalAccessRulesId }}' --required
AND requestId = '{{ requestId }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​