private_connections

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

Overview

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

Fields

The following fields are returned by SELECT queries:

get
list

Successful response

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`
`createTime`	`string (google-datetime)`	Output only. Creation time of this resource.
`description`	`string`	Optional. User-provided description for this private connection.
`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 (google-datetime)`	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}`

Successful response

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`
`createTime`	`string (google-datetime)`	Output only. Creation time of this resource.
`description`	`string`	Optional. User-provided description for this private connection.
`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 (google-datetime)`	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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `privateConnectionsId`		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`	`projectsId`, `locationsId`	`pageSize`, `pageToken`, `filter`, `orderBy`	Lists `PrivateConnection` resources in a given project and location.
`create`	`insert`	`projectsId`, `locationsId`	`privateConnectionId`, `requestId`	Creates a new private connection that can be used for accessing private Clouds.
`patch`	`update`	`projectsId`, `locationsId`, `privateConnectionsId`	`updateMask`, `requestId`	Modifies a `PrivateConnection` resource. Only `description` and `routing_mode` fields can be updated. Only fields specified in `updateMask` are applied.
`delete`	`delete`	`projectsId`, `locationsId`, `privateConnectionsId`	`requestId`	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.

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`
`privateConnectionsId`	`string`
`projectsId`	`string`
`filter`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`privateConnectionId`	`string`
`requestId`	`string`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

get
list

Retrieves a PrivateConnection resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.

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

Lists PrivateConnection resources in a given project and location.

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

`INSERT` examples

create
Manifest

Creates a new private connection that can be used for accessing private Clouds.

INSERT INTO google.vmwareengine.private_connections (
data__description,
data__vmwareEngineNetwork,
data__type,
data__routingMode,
data__serviceNetwork,
projectsId,
locationsId,
privateConnectionId,
requestId
)
SELECT 
'{{ description }}',
'{{ vmwareEngineNetwork }}',
'{{ type }}',
'{{ routingMode }}',
'{{ serviceNetwork }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ privateConnectionId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: private_connections
  props:
    - name: projectsId
      value: string
      description: Required parameter for the private_connections resource.
    - name: locationsId
      value: string
      description: Required parameter for the private_connections resource.
    - name: description
      value: string
      description: >
        Optional. User-provided description for this private connection.
        
    - name: vmwareEngineNetwork
      value: string
      description: >
        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.
        
    - name: type
      value: string
      description: >
        Required. Private connection type.
        
      valid_values: ['TYPE_UNSPECIFIED', 'PRIVATE_SERVICE_ACCESS', 'NETAPP_CLOUD_VOLUMES', 'DELL_POWERSCALE', 'THIRD_PARTY_SERVICE']
    - name: routingMode
      value: string
      description: >
        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.
        
      valid_values: ['ROUTING_MODE_UNSPECIFIED', 'GLOBAL', 'REGIONAL']
    - name: serviceNetwork
      value: string
      description: >
        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.
        
    - name: privateConnectionId
      value: string
    - name: requestId
      value: string

`UPDATE` examples

patch

Modifies a PrivateConnection resource. Only description and routing_mode fields can be updated. Only fields specified in updateMask are applied.

UPDATE google.vmwareengine.private_connections
SET 
data__description = '{{ description }}',
data__vmwareEngineNetwork = '{{ vmwareEngineNetwork }}',
data__type = '{{ type }}',
data__routingMode = '{{ routingMode }}',
data__serviceNetwork = '{{ serviceNetwork }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateConnectionsId = '{{ privateConnectionsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

delete

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.

DELETE FROM google.vmwareengine.private_connections
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateConnectionsId = '{{ privateConnectionsId }}' --required
AND requestId = '{{ requestId }}';

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​