Resource: Subnetwork
Represents a Subnetwork resource.
A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network.
JSON representation | |
---|---|
{ "id": string, "creationTimestamp": string, "name": string, "description": string, "network": string, "ipCidrRange": string, "gatewayAddress": string, "region": string, "selfLink": string, "privateIpGoogleAccess": boolean, "secondaryIpRanges": [ { "rangeName": string, "ipCidrRange": string } ], "fingerprint": string, "enableFlowLogs": boolean, "purpose": enum, "role": enum, "state": enum, "logConfig": { "enable": boolean, "aggregationInterval": enum, "flowSampling": number, "metadata": enum }, "kind": string } |
Fields | |
---|---|
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
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 |
description |
An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. |
network |
The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. |
ipCidrRange |
The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, |
gatewayAddress |
[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. |
region |
URL of the region where the Subnetwork resides. This field can be set only at resource creation time. |
selfLink |
[Output Only] Server-defined URL for the resource. |
privateIpGoogleAccess |
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 |
secondaryIpRanges[] |
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 |
secondaryIpRanges[].rangeName |
The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. |
secondaryIpRanges[].ipCidrRange |
The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. |
fingerprint |
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 To see the latest fingerprint, make a A base64-encoded string. |
enableFlowLogs |
Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in |
purpose |
The purpose of the resource. This field can be either |
role |
The role of subnetwork. Currenly, this field is only used when purpose = |
state |
[Output Only] The state of the subnetwork, which can be one of |
logConfig |
This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Stackdriver. |
logConfig.enable |
Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in |
logConfig.aggregationInterval |
Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. |
logConfig.flowSampling |
Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5, which means half of all collected logs are reported. |
logConfig.metadata |
Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is |
kind |
[Output Only] Type of the resource. Always |
Methods |
|
---|---|
|
Retrieves an aggregated list of subnetworks. |
|
Deletes the specified subnetwork. |
|
Expands the IP CIDR range of the subnetwork to a specified value. |
|
Returns the specified subnetwork. |
|
Gets the access control policy for a resource. |
|
Creates a subnetwork in the specified project using the data included in the request. |
|
Retrieves a list of subnetworks available to the specified project. |
|
Retrieves an aggregated list of all usable subnetworks in the project. |
|
Patches the specified subnetwork with the data included in the request. |
|
Sets the access control policy on the specified resource. |
|
Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. |
|
Returns permissions that a caller has on the specified resource. |