Skip to main content

subnetworks

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

Overview​

Namesubnetworks
TypeResource
Idgoogle.compute.subnetworks

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstring (uint64)Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
namestringThe name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
allowSubnetCidrRoutesOverlapbooleanWhether this subnetwork's ranges can conflict with existing custom routes. Setting this to true allows this subnetwork's primary and secondary ranges to overlap with (and contain) custom routes that have already been configured on the corresponding network. For example if a static route has range 10.1.0.0/16, a subnet range 10.0.0.0/8 could only be created if allow_conflicting_routes=true. Overlapping is only allowed on subnetwork operations; routes whose ranges conflict with this subnetwork's ranges won't be allowed unless route.allow_conflicting_subnetworks is set to true. Typically packets destined to IPs within the subnetwork (which may contain private/sensitive data) are prevented from leaving the virtual network. Setting this field to true will disable this feature. The default value is false and applies to all existing subnetworks and automatically created subnetworks.
creationTimestampstringOutput only. [Output Only] Creation timestamp inRFC3339 text format.
descriptionstringAn optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.
enableFlowLogsbooleanWhether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported if the subnet purpose field is set toREGIONAL_MANAGED_PROXY. It is recommended to uselogConfig.enable field instead.
externalIpv6PrefixstringThe external IPv6 address range that is owned by this subnetwork.
fingerprintstring (byte)Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork.
gatewayAddressstringOutput only. [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
internalIpv6PrefixstringThe internal IPv6 address range that is owned by this subnetwork.
ipCidrRangestringThe range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example,10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in theValid ranges list. The range can be expanded after creation usingexpandIpCidrRange.
ipCollectionstringReference to the source of IP, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must be a sub-PDP in EXTERNAL_IPV6_SUBNETWORK_CREATION or INTERNAL_IPV6_SUBNETWORK_CREATION mode. Use one of the following formats to specify a sub-PDP when creating a dual stack or IPv6-only subnetwork with external access using BYOIP: - Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name
ipv6AccessTypestringThe access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. (EXTERNAL, INTERNAL)
ipv6CidrRangestringOutput only. [Output Only] This field is for internal use.
ipv6GceEndpointstringOutput only. [Output Only] Possible endpoints of this subnetwork. It can be one of the following: - VM_ONLY: The subnetwork can be used for creating instances and IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6 ranges from a public delegated prefix and cannot be used to create NetLb. - VM_AND_FR: The subnetwork can be used for creating both VM instances and Forwarding Rules. It can also be used to reserve IPv6 addresses with both VM and FR endpoint types. Such a subnetwork gets its IPv6 range from Google IP Pool directly. (VM_AND_FR, VM_ONLY)
kindstringOutput only. [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. (default: compute#subnetwork)
logConfigobjectThis field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. (id: SubnetworkLogConfig)
networkstringThe URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time.
paramsobjectInput only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: SubnetworkParams)
privateIpGoogleAccessbooleanWhether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess.
privateIpv6GoogleAccessstringThis field is for internal use. This field can be both set at resource creation time and updated usingpatch. (DISABLE_GOOGLE_ACCESS, ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE, ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE)
purposestring (GLOBAL_MANAGED_PROXY, INTERNAL_HTTPS_LOAD_BALANCER, PEER_MIGRATION, PRIVATE, PRIVATE_NAT, PRIVATE_RFC_1918, PRIVATE_SERVICE_CONNECT, REGIONAL_MANAGED_PROXY)
regionstringURL of the region where the Subnetwork resides. This field can be set only at resource creation time.
reservedInternalRangestringThe URL of the reserved internal range.
resolveSubnetMaskstringConfigures subnet mask resolution for this subnetwork. (ARP_ALL_RANGES, ARP_PRIMARY_RANGE)
rolestringThe role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY orREGIONAL_MANAGED_PROXY. The value can be set toACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. (ACTIVE, BACKUP)
secondaryIpRangesarrayAn array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with apatch request. Supports both IPv4 and IPv6 ranges.
selfLinkstring[Output Only] Server-defined URL for the resource.
stackTypestringThe stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set toIPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated usingpatch. (IPV4_IPV6, IPV4_ONLY, IPV6_ONLY)
statestringOutput only. [Output Only] The state of the subnetwork, which can be one of the following values:READY: Subnetwork is created and ready to useDRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status ofREADY (DRAINING, READY)
systemReservedExternalIpv6RangesarrayOutput only. [Output Only] The array of external IPv6 network ranges reserved from the subnetwork's external IPv6 range for system use.
systemReservedInternalIpv6RangesarrayOutput only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use.
utilizationDetailsobjectOutput only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. (id: SubnetworkUtilizationDetails)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectproject, region, subnetworkviewsReturns the specified subnetwork.
listselectproject, regionreturnPartialSuccess, maxResults, pageToken, filter, orderBy, viewsRetrieves a list of subnetworks available to the specified
project.
aggregated_listselectprojectmaxResults, returnPartialSuccess, pageToken, filter, serviceProjectNumber, includeAllScopes, orderBy, viewsRetrieves an aggregated list of subnetworks.

To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.
insertinsertproject, regionrequestIdCreates a subnetwork in the specified project using the data
included in the request.
patchupdateproject, region, subnetworkdrainTimeoutSeconds, requestIdPatches the specified subnetwork with the data included in the request.
Only certain fields can be updated with a patch request
as indicated in the field descriptions.
You must specify the current fingerprint of the
subnetwork resource being patched.
deletedeleteproject, region, subnetworkrequestIdDeletes the specified subnetwork.
set_private_ip_google_accessexecproject, region, subnetworkrequestIdSet whether VMs in this subnet can access Google services without assigning
external IP addresses through Private Google Access.
expand_ip_cidr_rangeexecproject, region, subnetworkrequestIdExpands the IP CIDR range of the subnetwork to a specified value.

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.

NameDatatypeDescription
projectstring
regionstring
subnetworkstring
drainTimeoutSecondsinteger (int32)
filterstring
includeAllScopesboolean
maxResultsinteger (uint32)
orderBystring
pageTokenstring
requestIdstring
returnPartialSuccessboolean
serviceProjectNumberstring (int64)
viewsstring

SELECT examples​

Returns the specified subnetwork.

SELECT
id,
name,
allowSubnetCidrRoutesOverlap,
creationTimestamp,
description,
enableFlowLogs,
externalIpv6Prefix,
fingerprint,
gatewayAddress,
internalIpv6Prefix,
ipCidrRange,
ipCollection,
ipv6AccessType,
ipv6CidrRange,
ipv6GceEndpoint,
kind,
logConfig,
network,
params,
privateIpGoogleAccess,
privateIpv6GoogleAccess,
purpose,
region,
reservedInternalRange,
resolveSubnetMask,
role,
secondaryIpRanges,
selfLink,
stackType,
state,
systemReservedExternalIpv6Ranges,
systemReservedInternalIpv6Ranges,
utilizationDetails
FROM google.compute.subnetworks
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND subnetwork = '{{ subnetwork }}' -- required
AND views = '{{ views }}'
;

INSERT examples​

Creates a subnetwork in the specified project using the data
included in the request.

INSERT INTO google.compute.subnetworks (
data__description,
data__externalIpv6Prefix,
data__ipCollection,
data__name,
data__logConfig,
data__ipv6AccessType,
data__reservedInternalRange,
data__secondaryIpRanges,
data__enableFlowLogs,
data__internalIpv6Prefix,
data__role,
data__privateIpGoogleAccess,
data__selfLink,
data__purpose,
data__params,
data__allowSubnetCidrRoutesOverlap,
data__resolveSubnetMask,
data__network,
data__stackType,
data__ipCidrRange,
data__privateIpv6GoogleAccess,
data__region,
data__fingerprint,
project,
region,
requestId
)
SELECT 
'{{ description }}',
'{{ externalIpv6Prefix }}',
'{{ ipCollection }}',
'{{ name }}',
'{{ logConfig }}',
'{{ ipv6AccessType }}',
'{{ reservedInternalRange }}',
'{{ secondaryIpRanges }}',
{{ enableFlowLogs }},
'{{ internalIpv6Prefix }}',
'{{ role }}',
{{ privateIpGoogleAccess }},
'{{ selfLink }}',
'{{ purpose }}',
'{{ params }}',
{{ allowSubnetCidrRoutesOverlap }},
'{{ resolveSubnetMask }}',
'{{ network }}',
'{{ stackType }}',
'{{ ipCidrRange }}',
'{{ privateIpv6GoogleAccess }}',
'{{ region }}',
'{{ fingerprint }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

UPDATE examples​

Patches the specified subnetwork with the data included in the request.
Only certain fields can be updated with a patch request
as indicated in the field descriptions.
You must specify the current fingerprint of the
subnetwork resource being patched.

UPDATE google.compute.subnetworks
SET 
data__description = '{{ description }}',
data__externalIpv6Prefix = '{{ externalIpv6Prefix }}',
data__ipCollection = '{{ ipCollection }}',
data__name = '{{ name }}',
data__logConfig = '{{ logConfig }}',
data__ipv6AccessType = '{{ ipv6AccessType }}',
data__reservedInternalRange = '{{ reservedInternalRange }}',
data__secondaryIpRanges = '{{ secondaryIpRanges }}',
data__enableFlowLogs = {{ enableFlowLogs }},
data__internalIpv6Prefix = '{{ internalIpv6Prefix }}',
data__role = '{{ role }}',
data__privateIpGoogleAccess = {{ privateIpGoogleAccess }},
data__selfLink = '{{ selfLink }}',
data__purpose = '{{ purpose }}',
data__params = '{{ params }}',
data__allowSubnetCidrRoutesOverlap = {{ allowSubnetCidrRoutesOverlap }},
data__resolveSubnetMask = '{{ resolveSubnetMask }}',
data__network = '{{ network }}',
data__stackType = '{{ stackType }}',
data__ipCidrRange = '{{ ipCidrRange }}',
data__privateIpv6GoogleAccess = '{{ privateIpv6GoogleAccess }}',
data__region = '{{ region }}',
data__fingerprint = '{{ fingerprint }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND subnetwork = '{{ subnetwork }}' --required
AND drainTimeoutSeconds = '{{ drainTimeoutSeconds}}'
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples​

Deletes the specified subnetwork.

DELETE FROM google.compute.subnetworks
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND subnetwork = '{{ subnetwork }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods​

Set whether VMs in this subnet can access Google services without assigning
external IP addresses through Private Google Access.

EXEC google.compute.subnetworks.set_private_ip_google_access 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@subnetwork='{{ subnetwork }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"privateIpGoogleAccess": {{ privateIpGoogleAccess }}
}'
;