private_connections

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

Overview

Name	private_connections
Type	Resource
Id	google.vmwareengine.private_connections

Fields

Name	Datatype	Description
name	string	Output only. The resource name of the private connection. 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/privateConnections/my-connection
description	string	Optional. User-provided description for this private connection.
createTime	string	Output only. Creation time of this resource.
peeringId	string	Output only. VPC network peering id between given network VPC and VMwareEngineNetwork.
peeringState	string	Output only. Peering state between service network and VMware Engine network.
routingMode	string	Optional. Routing Mode. Default value is set to GLOBAL. For type = PRIVATE_SERVICE_ACCESS, this field can be set to GLOBAL or REGIONAL, for other types only GLOBAL is supported.
serviceNetwork	string	Required. Service network to create private connection. Specify the name in the following form: projects/{project}/global/networks/{network_id} For type = PRIVATE_SERVICE_ACCESS, this field represents servicenetworking VPC, e.g. projects/project-tp/global/networks/servicenetworking. For type = NETAPP_CLOUD_VOLUME, this field represents NetApp service VPC, e.g. projects/project-tp/global/networks/netapp-tenant-vpc. For type = DELL_POWERSCALE, this field represent Dell service VPC, e.g. projects/project-tp/global/networks/dell-tenant-vpc. For type= THIRD_PARTY_SERVICE, this field could represent a consumer VPC or any other producer VPC to which the VMware Engine Network needs to be connected, e.g. projects/project/global/networks/vpc.
state	string	Output only. State of the private connection.
type	string	Required. Private connection type.
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string	Output only. Last update time of this resource.
vmwareEngineNetwork	string	Required. The relative resource name of Legacy VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id} where {project}, {location} will be same as specified in private connection resource name and {vmware_engine_network_id} will be in the form of {location}-default e.g. projects/project/locations/us-central1/vmwareEngineNetworks/us-central1-default.
vmwareEngineNetworkCanonical	string	Output only. The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, privateConnectionsId, projectsId	Retrieves a PrivateConnection resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.
list	SELECT	locationsId, projectsId	Lists PrivateConnection resources in a given project and location.
create	INSERT	locationsId, projectsId	Creates a new private connection that can be used for accessing private Clouds.
delete	DELETE	locationsId, privateConnectionsId, projectsId	Deletes a PrivateConnection resource. When a private connection is deleted for a VMware Engine network, the connected network becomes inaccessible to that VMware Engine network.
patch	UPDATE	locationsId, privateConnectionsId, projectsId	Modifies a PrivateConnection resource. Only description and routing_mode fields can be updated. Only fields specified in updateMask are applied.

SELECT examples

Lists PrivateConnection resources in a given project and location.

SELECT
name,
description,
createTime,
peeringId,
peeringState,
routingMode,
serviceNetwork,
state,
type,
uid,
updateTime,
vmwareEngineNetwork,
vmwareEngineNetworkCanonical
FROM google.vmwareengine.private_connections
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new private_connections resource.

All Properties

/*+ create */
INSERT INTO google.vmwareengine.private_connections (
locationsId,
projectsId,
description,
vmwareEngineNetwork,
type,
routingMode,
serviceNetwork
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ description }}',
'{{ vmwareEngineNetwork }}',
'{{ type }}',
'{{ routingMode }}',
'{{ serviceNetwork }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: description
      value: string
    - name: state
      value: string
    - name: vmwareEngineNetwork
      value: string
    - name: vmwareEngineNetworkCanonical
      value: string
    - name: type
      value: string
    - name: peeringId
      value: string
    - name: routingMode
      value: string
    - name: uid
      value: string
    - name: serviceNetwork
      value: string
    - name: peeringState
      value: string

UPDATE example

Updates a private_connections resource.

/*+ update */
UPDATE google.vmwareengine.private_connections
SET 
description = '{{ description }}',
vmwareEngineNetwork = '{{ vmwareEngineNetwork }}',
type = '{{ type }}',
routingMode = '{{ routingMode }}',
serviceNetwork = '{{ serviceNetwork }}'
WHERE 
locationsId = '{{ locationsId }}'
AND privateConnectionsId = '{{ privateConnectionsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified private_connections resource.

/*+ delete */
DELETE FROM google.vmwareengine.private_connections
WHERE locationsId = '{{ locationsId }}'
AND privateConnectionsId = '{{ privateConnectionsId }}'
AND projectsId = '{{ projectsId }}';