subnetworks

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

Overview

Name	`subnetworks`
Type	Resource
Id	`google.compute.subnetworks`

Fields

Name	Datatype	Description
`id`	`string`	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`name`	`string`	The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. 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.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC3339 text format.
`enableFlowLogs`	`boolean`	Whether 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 to REGIONAL_MANAGED_PROXY.
`externalIpv6Prefix`	`string`	The external IPv6 address range that is owned by this subnetwork.
`fingerprint`	`string`	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.
`gatewayAddress`	`string`	[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
`internalIpv6Prefix`	`string`	The internal IPv6 address range that is owned by this subnetwork.
`ipCidrRange`	`string`	The 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 the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.
`ipv6AccessType`	`string`	The 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.
`ipv6CidrRange`	`string`	[Output Only] This field is for internal use.
`kind`	`string`	[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
`logConfig`	`object`	The available logging options for this subnetwork.
`network`	`string`	The 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.
`privateIpGoogleAccess`	`boolean`	Whether 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.
`privateIpv6GoogleAccess`	`string`	This field is for internal use. This field can be both set at resource creation time and updated using patch.
`purpose`	`string`	The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.
`region`	`string`	URL of the region where the Subnetwork resides. This field can be set only at resource creation time.
`reservedInternalRange`	`string`	The URL of the reserved internal range.
`role`	`string`	The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE 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.
`secondaryIpRanges`	`array`	An 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 a patch request.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`stackType`	`string`	The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_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 using patch.
`state`	`string`	[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: 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 of READY

Methods

Name	Accessible by	Required Params	Description
`aggregated_list`	`SELECT`	`project`	Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
`get`	`SELECT`	`project, region, subnetwork`	Returns the specified subnetwork.
`list`	`SELECT`	`project, region`	Retrieves a list of subnetworks available to the specified project.
`insert`	`INSERT`	`project, region`	Creates a subnetwork in the specified project using the data included in the request.
`delete`	`DELETE`	`project, region, subnetwork`	Deletes the specified subnetwork.
`patch`	`UPDATE`	`project, region, subnetwork`	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.
`expand_ip_cidr_range`	`EXEC`	`project, region, subnetwork`	Expands the IP CIDR range of the subnetwork to a specified value.
`set_private_ip_google_access`	`EXEC`	`project, region, subnetwork`	Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.

`SELECT` examples

Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

SELECT
id,
name,
description,
creationTimestamp,
enableFlowLogs,
externalIpv6Prefix,
fingerprint,
gatewayAddress,
internalIpv6Prefix,
ipCidrRange,
ipv6AccessType,
ipv6CidrRange,
kind,
logConfig,
network,
privateIpGoogleAccess,
privateIpv6GoogleAccess,
purpose,
region,
reservedInternalRange,
role,
secondaryIpRanges,
selfLink,
stackType,
state
FROM google.compute.subnetworks
WHERE project = '{{ project }}';

`INSERT` example

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

All Properties
Manifest

/*+ create */
INSERT INTO google.compute.subnetworks (
project,
region,
name,
description,
network,
ipCidrRange,
reservedInternalRange,
gatewayAddress,
region,
privateIpGoogleAccess,
secondaryIpRanges,
fingerprint,
enableFlowLogs,
privateIpv6GoogleAccess,
ipv6CidrRange,
externalIpv6Prefix,
internalIpv6Prefix,
purpose,
role,
state,
logConfig,
stackType,
ipv6AccessType
)
SELECT 
'{{ project }}',
'{{ region }}',
'{{ name }}',
'{{ description }}',
'{{ network }}',
'{{ ipCidrRange }}',
'{{ reservedInternalRange }}',
'{{ gatewayAddress }}',
'{{ region }}',
{{ privateIpGoogleAccess }},
'{{ secondaryIpRanges }}',
'{{ fingerprint }}',
{{ enableFlowLogs }},
'{{ privateIpv6GoogleAccess }}',
'{{ ipv6CidrRange }}',
'{{ externalIpv6Prefix }}',
'{{ internalIpv6Prefix }}',
'{{ purpose }}',
'{{ role }}',
'{{ state }}',
'{{ logConfig }}',
'{{ stackType }}',
'{{ ipv6AccessType }}'
;

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: network
      value: string
    - name: ipCidrRange
      value: string
    - name: reservedInternalRange
      value: string
    - name: gatewayAddress
      value: string
    - name: region
      value: string
    - name: selfLink
      value: string
    - name: privateIpGoogleAccess
      value: boolean
    - name: secondaryIpRanges
      value:
        - - name: rangeName
            value: string
          - name: ipCidrRange
            value: string
          - name: reservedInternalRange
            value: string
    - name: fingerprint
      value: string
    - name: enableFlowLogs
      value: boolean
    - name: privateIpv6GoogleAccess
      value: string
    - name: ipv6CidrRange
      value: string
    - name: externalIpv6Prefix
      value: string
    - name: internalIpv6Prefix
      value: string
    - name: purpose
      value: string
    - name: role
      value: string
    - name: state
      value: string
    - name: logConfig
      value:
        - name: enable
          value: boolean
        - name: aggregationInterval
          value: string
        - name: flowSampling
          value: number
        - name: metadata
          value: string
        - name: metadataFields
          value:
            - string
        - name: filterExpr
          value: string
    - name: stackType
      value: string
    - name: ipv6AccessType
      value: string

`UPDATE` example

Updates a subnetworks resource.

/*+ update */
UPDATE google.compute.subnetworks
SET 
name = '{{ name }}',
description = '{{ description }}',
network = '{{ network }}',
ipCidrRange = '{{ ipCidrRange }}',
reservedInternalRange = '{{ reservedInternalRange }}',
gatewayAddress = '{{ gatewayAddress }}',
region = '{{ region }}',
privateIpGoogleAccess = true|false,
secondaryIpRanges = '{{ secondaryIpRanges }}',
fingerprint = '{{ fingerprint }}',
enableFlowLogs = true|false,
privateIpv6GoogleAccess = '{{ privateIpv6GoogleAccess }}',
ipv6CidrRange = '{{ ipv6CidrRange }}',
externalIpv6Prefix = '{{ externalIpv6Prefix }}',
internalIpv6Prefix = '{{ internalIpv6Prefix }}',
purpose = '{{ purpose }}',
role = '{{ role }}',
state = '{{ state }}',
logConfig = '{{ logConfig }}',
stackType = '{{ stackType }}',
ipv6AccessType = '{{ ipv6AccessType }}'
WHERE 
project = '{{ project }}'
AND region = '{{ region }}'
AND subnetwork = '{{ subnetwork }}';

`DELETE` example

Deletes the specified subnetworks resource.

/*+ delete */
DELETE FROM google.compute.subnetworks
WHERE project = '{{ project }}'
AND region = '{{ region }}'
AND subnetwork = '{{ subnetwork }}';

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

UPDATE example​

DELETE example​