external_addresses

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

Overview

Name	external_addresses
Type	Resource
Id	google.vmwareengine.external_addresses

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of this external IP address. 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-a/privateClouds/my-cloud/externalAddresses/my-address
createTime	string (google-datetime)	Output only. Creation time of this resource.
description	string	User-provided description for this resource.
externalIp	string	Output only. The external IP address of a workload VM.
internalIp	string	The internal IP address of a workload VM.
state	string	Output only. The state of the resource.
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string (google-datetime)	Output only. Last update time of this resource.

list

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of this external IP address. 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-a/privateClouds/my-cloud/externalAddresses/my-address
createTime	string (google-datetime)	Output only. Creation time of this resource.
description	string	User-provided description for this resource.
externalIp	string	Output only. The external IP address of a workload VM.
internalIp	string	The internal IP address of a workload VM.
state	string	Output only. The state of the resource.
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, privateCloudsId, externalAddressesId		Gets details of a single external IP address.
list	select	projectsId, locationsId, privateCloudsId	pageSize, pageToken, filter, orderBy	Lists external IP addresses assigned to VMware workload VMs in a given private cloud.
create	insert	projectsId, locationsId, privateCloudsId	externalAddressId, requestId	Creates a new ExternalAddress resource in a given private cloud. The network policy that corresponds to the private cloud must have the external IP address network service enabled (NetworkPolicy.external_ip).
patch	update	projectsId, locationsId, privateCloudsId, externalAddressesId	updateMask, requestId	Updates the parameters of a single external IP address. Only fields specified in update_mask are applied. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
delete	delete	projectsId, locationsId, privateCloudsId, externalAddressesId	requestId	Deletes a single external IP address. When you delete an external IP address, connectivity between the external IP address and the corresponding internal IP address is lost.

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
externalAddressesId	string
locationsId	string
privateCloudsId	string
projectsId	string
externalAddressId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single external IP address.

SELECT
name,
createTime,
description,
externalIp,
internalIp,
state,
uid,
updateTime
FROM google.vmwareengine.external_addresses
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND externalAddressesId = '{{ externalAddressesId }}' -- required;

list

Lists external IP addresses assigned to VMware workload VMs in a given private cloud.

SELECT
name,
createTime,
description,
externalIp,
internalIp,
state,
uid,
updateTime
FROM google.vmwareengine.external_addresses
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new ExternalAddress resource in a given private cloud. The network policy that corresponds to the private cloud must have the external IP address network service enabled (NetworkPolicy.external_ip).

INSERT INTO google.vmwareengine.external_addresses (
data__internalIp,
data__description,
projectsId,
locationsId,
privateCloudsId,
externalAddressId,
requestId
)
SELECT 
'{{ internalIp }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ privateCloudsId }}',
'{{ externalAddressId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: external_addresses
  props:
    - name: projectsId
      value: string
      description: Required parameter for the external_addresses resource.
    - name: locationsId
      value: string
      description: Required parameter for the external_addresses resource.
    - name: privateCloudsId
      value: string
      description: Required parameter for the external_addresses resource.
    - name: internalIp
      value: string
      description: >
        The internal IP address of a workload VM.
        
    - name: description
      value: string
      description: >
        User-provided description for this resource.
        
    - name: externalAddressId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates the parameters of a single external IP address. Only fields specified in update_mask are applied. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

UPDATE google.vmwareengine.external_addresses
SET 
data__internalIp = '{{ internalIp }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateCloudsId = '{{ privateCloudsId }}' --required
AND externalAddressesId = '{{ externalAddressesId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single external IP address. When you delete an external IP address, connectivity between the external IP address and the corresponding internal IP address is lost.

DELETE FROM google.vmwareengine.external_addresses
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateCloudsId = '{{ privateCloudsId }}' --required
AND externalAddressesId = '{{ externalAddressesId }}' --required
AND requestId = '{{ requestId }}';