vmware_engine_networks

Creates, updates, deletes, gets or lists a vmware_engine_networks resource.

Overview

Name	vmware_engine_networks
Type	Resource
Id	google.vmwareengine.vmware_engine_networks

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/vmwareEngineNetworks/my-network
createTime	string (google-datetime)	Output only. Creation time of this resource.
description	string	User-provided description for this VMware Engine network.
etag	string	Checksum that may be sent on update and delete requests to ensure that the user-provided value is up to date before the server processes a request. The server computes checksums based on the value of other fields in the request.
state	string	Output only. State of the VMware Engine network.
type	string	Required. VMware Engine network type.
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string (google-datetime)	Output only. Last update time of this resource.
vpcNetworks	array	Output only. VMware Engine service VPC networks that provide connectivity from a private cloud to customer projects, the internet, and other Google Cloud services.

list

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/vmwareEngineNetworks/my-network
createTime	string (google-datetime)	Output only. Creation time of this resource.
description	string	User-provided description for this VMware Engine network.
etag	string	Checksum that may be sent on update and delete requests to ensure that the user-provided value is up to date before the server processes a request. The server computes checksums based on the value of other fields in the request.
state	string	Output only. State of the VMware Engine network.
type	string	Required. VMware Engine network type.
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string (google-datetime)	Output only. Last update time of this resource.
vpcNetworks	array	Output only. VMware Engine service VPC networks that provide connectivity from a private cloud to customer projects, the internet, and other Google Cloud services.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, vmwareEngineNetworksId		Retrieves a VmwareEngineNetwork resource by its resource name. The resource contains details of the VMware Engine network, such as its VMware Engine network type, peered networks in a service project, and state (for example, CREATING, ACTIVE, DELETING).
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists VmwareEngineNetwork resources in a given project and location.
create	insert	projectsId, locationsId	vmwareEngineNetworkId, requestId	Creates a new VMware Engine network that can be used by a private cloud.
patch	update	projectsId, locationsId, vmwareEngineNetworksId	updateMask, requestId	Modifies a VMware Engine network resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied.
delete	delete	projectsId, locationsId, vmwareEngineNetworksId	requestId, etag	Deletes a VmwareEngineNetwork resource. You can only delete a VMware Engine network after all resources that refer to it are deleted. For example, a private cloud, a network peering, and a network policy can all refer to the same VMware Engine network.

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
locationsId	string
projectsId	string
vmwareEngineNetworksId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)
vmwareEngineNetworkId	string

SELECT examples

get

Retrieves a VmwareEngineNetwork resource by its resource name. The resource contains details of the VMware Engine network, such as its VMware Engine network type, peered networks in a service project, and state (for example, CREATING, ACTIVE, DELETING).

SELECT
name,
createTime,
description,
etag,
state,
type,
uid,
updateTime,
vpcNetworks
FROM google.vmwareengine.vmware_engine_networks
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND vmwareEngineNetworksId = '{{ vmwareEngineNetworksId }}' -- required;

list

Lists VmwareEngineNetwork resources in a given project and location.

SELECT
name,
createTime,
description,
etag,
state,
type,
uid,
updateTime,
vpcNetworks
FROM google.vmwareengine.vmware_engine_networks
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new VMware Engine network that can be used by a private cloud.

INSERT INTO google.vmwareengine.vmware_engine_networks (
data__description,
data__type,
data__etag,
projectsId,
locationsId,
vmwareEngineNetworkId,
requestId
)
SELECT 
'{{ description }}',
'{{ type }}',
'{{ etag }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ vmwareEngineNetworkId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: vmware_engine_networks
  props:
    - name: projectsId
      value: string
      description: Required parameter for the vmware_engine_networks resource.
    - name: locationsId
      value: string
      description: Required parameter for the vmware_engine_networks resource.
    - name: description
      value: string
      description: >
        User-provided description for this VMware Engine network.
        
    - name: type
      value: string
      description: >
        Required. VMware Engine network type.
        
      valid_values: ['TYPE_UNSPECIFIED', 'LEGACY', 'STANDARD']
    - name: etag
      value: string
      description: >
        Checksum that may be sent on update and delete requests to ensure that the user-provided value is up to date before the server processes a request. The server computes checksums based on the value of other fields in the request.
        
    - name: vmwareEngineNetworkId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Modifies a VMware Engine network resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied.

UPDATE google.vmwareengine.vmware_engine_networks
SET 
data__description = '{{ description }}',
data__type = '{{ type }}',
data__etag = '{{ etag }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND vmwareEngineNetworksId = '{{ vmwareEngineNetworksId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a VmwareEngineNetwork resource. You can only delete a VMware Engine network after all resources that refer to it are deleted. For example, a private cloud, a network peering, and a network policy can all refer to the same VMware Engine network.

DELETE FROM google.vmwareengine.vmware_engine_networks
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND vmwareEngineNetworksId = '{{ vmwareEngineNetworksId }}' --required
AND requestId = '{{ requestId }}'
AND etag = '{{ etag }}';