network_peerings

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

Overview

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

Fields

The following fields are returned by SELECT queries:

get
list

Successful response

Name	Datatype	Description
`name`	`string`	Output only. Identifier. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering`
`createTime`	`string (google-datetime)`	Output only. Creation time of this resource.
`description`	`string`	Optional. User-provided description for this network peering.
`exchangeSubnetRoutes`	`boolean`	Optional. True if full mesh connectivity is created and managed automatically between peered networks; false otherwise. Currently this field is always true because Google Compute Engine automatically creates and manages subnetwork routes between two VPC networks when peering state is 'ACTIVE'.
`exportCustomRoutes`	`boolean`	Optional. True if custom routes are exported to the peered network; false otherwise. The default value is true.
`exportCustomRoutesWithPublicIp`	`boolean`	Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field.
`importCustomRoutes`	`boolean`	Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true.
`importCustomRoutesWithPublicIp`	`boolean`	Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field.
`peerMtu`	`integer (int32)`	Optional. Maximum transmission unit (MTU) in bytes. The default value is `1500`. If a value of `0` is provided for this field, VMware Engine uses the default value instead.
`peerNetwork`	`string`	Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the `peer_network_type` is VMWARE_ENGINE_NETWORK, specify the name in the form: `projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}`. Otherwise specify the name in the form: `projects/{project}/global/networks/{network_id}`, where `{project}` can either be a project number or a project ID.
`peerNetworkType`	`string`	Required. The type of the network to peer with the VMware Engine network.
`state`	`string`	Output only. State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
`stateDetails`	`string`	Output only. Output Only. Details about the current state of the network peering.
`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 the VMware Engine network. Specify the name in the following form: `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` where `{project}` can either be a project number or a project ID.

Successful response

Name	Datatype	Description
`name`	`string`	Output only. Identifier. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering`
`createTime`	`string (google-datetime)`	Output only. Creation time of this resource.
`description`	`string`	Optional. User-provided description for this network peering.
`exchangeSubnetRoutes`	`boolean`	Optional. True if full mesh connectivity is created and managed automatically between peered networks; false otherwise. Currently this field is always true because Google Compute Engine automatically creates and manages subnetwork routes between two VPC networks when peering state is 'ACTIVE'.
`exportCustomRoutes`	`boolean`	Optional. True if custom routes are exported to the peered network; false otherwise. The default value is true.
`exportCustomRoutesWithPublicIp`	`boolean`	Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field.
`importCustomRoutes`	`boolean`	Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true.
`importCustomRoutesWithPublicIp`	`boolean`	Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field.
`peerMtu`	`integer (int32)`	Optional. Maximum transmission unit (MTU) in bytes. The default value is `1500`. If a value of `0` is provided for this field, VMware Engine uses the default value instead.
`peerNetwork`	`string`	Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the `peer_network_type` is VMWARE_ENGINE_NETWORK, specify the name in the form: `projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}`. Otherwise specify the name in the form: `projects/{project}/global/networks/{network_id}`, where `{project}` can either be a project number or a project ID.
`peerNetworkType`	`string`	Required. The type of the network to peer with the VMware Engine network.
`state`	`string`	Output only. State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
`stateDetails`	`string`	Output only. Output Only. Details about the current state of the network peering.
`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 the VMware Engine network. Specify the name in the following form: `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` where `{project}` can either be a project number or a project ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `networkPeeringsId`		Retrieves a `NetworkPeering` resource by its resource name. The resource contains details of the network peering, such as peered networks, import and export custom route configurations, and peering state. NetworkPeering is a global resource and location can only be global.
`list`	`select`	`projectsId`, `locationsId`	`pageSize`, `pageToken`, `filter`, `orderBy`	Lists `NetworkPeering` resources in a given project. NetworkPeering is a global resource and location can only be global.
`create`	`insert`	`projectsId`, `locationsId`	`networkPeeringId`, `requestId`	Creates a new network peering between the peer network and VMware Engine network provided in a `NetworkPeering` resource. NetworkPeering is a global resource and location can only be global.
`patch`	`update`	`projectsId`, `locationsId`, `networkPeeringsId`	`updateMask`, `requestId`	Modifies a `NetworkPeering` resource. Only the `description` field can be updated. Only fields specified in `updateMask` are applied. NetworkPeering is a global resource and location can only be global.
`delete`	`delete`	`projectsId`, `locationsId`, `networkPeeringsId`	`requestId`	Deletes a `NetworkPeering` resource. When a network peering is deleted for a VMware Engine network, the peer network becomes inaccessible to that VMware Engine network. NetworkPeering is a global resource and location can only be global.

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

`SELECT` examples

get
list

Retrieves a NetworkPeering resource by its resource name. The resource contains details of the network peering, such as peered networks, import and export custom route configurations, and peering state. NetworkPeering is a global resource and location can only be global.

SELECT
name,
createTime,
description,
exchangeSubnetRoutes,
exportCustomRoutes,
exportCustomRoutesWithPublicIp,
importCustomRoutes,
importCustomRoutesWithPublicIp,
peerMtu,
peerNetwork,
peerNetworkType,
state,
stateDetails,
uid,
updateTime,
vmwareEngineNetwork
FROM google.vmwareengine.network_peerings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND networkPeeringsId = '{{ networkPeeringsId }}' -- required;

Lists NetworkPeering resources in a given project. NetworkPeering is a global resource and location can only be global.

SELECT
name,
createTime,
description,
exchangeSubnetRoutes,
exportCustomRoutes,
exportCustomRoutesWithPublicIp,
importCustomRoutes,
importCustomRoutesWithPublicIp,
peerMtu,
peerNetwork,
peerNetworkType,
state,
stateDetails,
uid,
updateTime,
vmwareEngineNetwork
FROM google.vmwareengine.network_peerings
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 network peering between the peer network and VMware Engine network provided in a NetworkPeering resource. NetworkPeering is a global resource and location can only be global.

INSERT INTO google.vmwareengine.network_peerings (
data__peerNetwork,
data__exportCustomRoutes,
data__importCustomRoutes,
data__exchangeSubnetRoutes,
data__exportCustomRoutesWithPublicIp,
data__importCustomRoutesWithPublicIp,
data__peerMtu,
data__peerNetworkType,
data__vmwareEngineNetwork,
data__description,
projectsId,
locationsId,
networkPeeringId,
requestId
)
SELECT 
'{{ peerNetwork }}',
{{ exportCustomRoutes }},
{{ importCustomRoutes }},
{{ exchangeSubnetRoutes }},
{{ exportCustomRoutesWithPublicIp }},
{{ importCustomRoutesWithPublicIp }},
{{ peerMtu }},
'{{ peerNetworkType }}',
'{{ vmwareEngineNetwork }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ networkPeeringId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: network_peerings
  props:
    - name: projectsId
      value: string
      description: Required parameter for the network_peerings resource.
    - name: locationsId
      value: string
      description: Required parameter for the network_peerings resource.
    - name: peerNetwork
      value: string
      description: >
        Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the `peer_network_type` is VMWARE_ENGINE_NETWORK, specify the name in the form: `projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}`. Otherwise specify the name in the form: `projects/{project}/global/networks/{network_id}`, where `{project}` can either be a project number or a project ID.
        
    - name: exportCustomRoutes
      value: boolean
      description: >
        Optional. True if custom routes are exported to the peered network; false otherwise. The default value is true.
        
    - name: importCustomRoutes
      value: boolean
      description: >
        Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true.
        
    - name: exchangeSubnetRoutes
      value: boolean
      description: >
        Optional. True if full mesh connectivity is created and managed automatically between peered networks; false otherwise. Currently this field is always true because Google Compute Engine automatically creates and manages subnetwork routes between two VPC networks when peering state is 'ACTIVE'.
        
    - name: exportCustomRoutesWithPublicIp
      value: boolean
      description: >
        Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field.
        
    - name: importCustomRoutesWithPublicIp
      value: boolean
      description: >
        Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field.
        
    - name: peerMtu
      value: integer
      description: >
        Optional. Maximum transmission unit (MTU) in bytes. The default value is `1500`. If a value of `0` is provided for this field, VMware Engine uses the default value instead.
        
    - name: peerNetworkType
      value: string
      description: >
        Required. The type of the network to peer with the VMware Engine network.
        
      valid_values: ['PEER_NETWORK_TYPE_UNSPECIFIED', 'STANDARD', 'VMWARE_ENGINE_NETWORK', 'PRIVATE_SERVICES_ACCESS', 'NETAPP_CLOUD_VOLUMES', 'THIRD_PARTY_SERVICE', 'DELL_POWERSCALE', 'GOOGLE_CLOUD_NETAPP_VOLUMES', 'GOOGLE_CLOUD_FILESTORE_INSTANCES']
    - name: vmwareEngineNetwork
      value: string
      description: >
        Required. The relative resource name of the VMware Engine network. Specify the name in the following form: `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` where `{project}` can either be a project number or a project ID.
        
    - name: description
      value: string
      description: >
        Optional. User-provided description for this network peering.
        
    - name: networkPeeringId
      value: string
    - name: requestId
      value: string

`UPDATE` examples

patch

Modifies a NetworkPeering resource. Only the description field can be updated. Only fields specified in updateMask are applied. NetworkPeering is a global resource and location can only be global.

UPDATE google.vmwareengine.network_peerings
SET 
data__peerNetwork = '{{ peerNetwork }}',
data__exportCustomRoutes = {{ exportCustomRoutes }},
data__importCustomRoutes = {{ importCustomRoutes }},
data__exchangeSubnetRoutes = {{ exchangeSubnetRoutes }},
data__exportCustomRoutesWithPublicIp = {{ exportCustomRoutesWithPublicIp }},
data__importCustomRoutesWithPublicIp = {{ importCustomRoutesWithPublicIp }},
data__peerMtu = {{ peerMtu }},
data__peerNetworkType = '{{ peerNetworkType }}',
data__vmwareEngineNetwork = '{{ vmwareEngineNetwork }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND networkPeeringsId = '{{ networkPeeringsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

delete

Deletes a NetworkPeering resource. When a network peering is deleted for a VMware Engine network, the peer network becomes inaccessible to that VMware Engine network. NetworkPeering is a global resource and location can only be global.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​