Class 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.

Inheritance
object
Subnetwork
Implements
Inherited Members
Namespace: Google.Apis.Compute.alpha.Data
Assembly: Google.Apis.Compute.alpha.dll
Syntax
public class Subnetwork : IDirectResponseSchema

Properties

AggregationInterval

Can only be specified if VPC flow logging for this subnetwork is enabled. Sets the aggregation interval for collecting flow logs. Increasing the interval time reduces the amount of generated flow logs for long-lasting connections. Default is an interval of 5 seconds per connection. Valid values: INTERVAL_5_SEC, INTERVAL_30_SEC, INTERVAL_1_MIN, INTERVAL_5_MIN, INTERVAL_10_MIN, INTERVAL_15_MIN.

Declaration
[JsonProperty("aggregationInterval")]
public virtual string AggregationInterval { get; set; }
Property Value
Type Description
string

AllowSubnetCidrRoutesOverlap

Whether this subnetwork's ranges can conflict with existing static routes. Setting this to true allows this subnetwork's primary and secondary ranges to overlap with (and contain) static 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. This field cannot be set to true at resource creation time.

Declaration
[JsonProperty("allowSubnetCidrRoutesOverlap")]
public virtual bool? AllowSubnetCidrRoutesOverlap { get; set; }
Property Value
Type Description
bool?

CreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Declaration
[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EnableFlowLogs

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.

Declaration
[JsonProperty("enableFlowLogs")]
public virtual bool? EnableFlowLogs { get; set; }
Property Value
Type Description
bool?

EnableL2

Enables Layer2 communication on the subnetwork.

Declaration
[JsonProperty("enableL2")]
public virtual bool? EnableL2 { get; set; }
Property Value
Type Description
bool?

EnablePrivateV6Access

Deprecated in favor of enable in PrivateIpv6GoogleAccess. Whether the VMs in this subnet can directly access Google services via internal IPv6 addresses. This field can be both set at resource creation time and updated using patch.

Declaration
[JsonProperty("enablePrivateV6Access")]
public virtual bool? EnablePrivateV6Access { get; set; }
Property Value
Type Description
bool?

ExternalIpv6Prefix

The external IPv6 address range that is owned by this subnetwork.

Declaration
[JsonProperty("externalIpv6Prefix")]
public virtual string ExternalIpv6Prefix { get; set; }
Property Value
Type Description
string

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 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.

Declaration
[JsonProperty("fingerprint")]
public virtual string Fingerprint { get; set; }
Property Value
Type Description
string

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 unless otherwise specified by the org policy, which means half of all collected logs are reported.

Declaration
[JsonProperty("flowSampling")]
public virtual float? FlowSampling { get; set; }
Property Value
Type Description
float?

GatewayAddress

[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.

Declaration
[JsonProperty("gatewayAddress")]
public virtual string GatewayAddress { get; set; }
Property Value
Type Description
string

Id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Declaration
[JsonProperty("id")]
public virtual ulong? Id { get; set; }
Property Value
Type Description
ulong?

InternalIpv6Prefix

The internal IPv6 address range that is owned by this subnetwork.

Declaration
[JsonProperty("internalIpv6Prefix")]
public virtual string InternalIpv6Prefix { get; set; }
Property Value
Type Description
string

IpCidrRange

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.

Declaration
[JsonProperty("ipCidrRange")]
public virtual string IpCidrRange { get; set; }
Property Value
Type Description
string

IpCollection

Reference to the source of IP, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must be a sub-PDP in EXTERNAL_IPV6_SUBNETWORK_CREATION mode. Use one of the following formats to specify a sub-PDP when creating a dual stack subnetwork with external access using BYOIP: - Full resource URL, as in https://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

Declaration
[JsonProperty("ipCollection")]
public virtual string IpCollection { get; set; }
Property Value
Type Description
string

Ipv6AccessType

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.

Declaration
[JsonProperty("ipv6AccessType")]
public virtual string Ipv6AccessType { get; set; }
Property Value
Type Description
string

Ipv6CidrRange

[Output Only] This field is for internal use.

Declaration
[JsonProperty("ipv6CidrRange")]
public virtual string Ipv6CidrRange { get; set; }
Property Value
Type Description
string

Ipv6GceEndpoint

[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.

Declaration
[JsonProperty("ipv6GceEndpoint")]
public virtual string Ipv6GceEndpoint { get; set; }
Property Value
Type Description
string

Kind

[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
string

LogConfig

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

Declaration
[JsonProperty("logConfig")]
public virtual SubnetworkLogConfig LogConfig { get; set; }
Property Value
Type Description
SubnetworkLogConfig

Metadata

Can only be specified if VPC flow logging for this subnetwork is enabled. Configures whether metadata fields should be added to the reported VPC flow logs. Options are INCLUDE_ALL_METADATA, EXCLUDE_ALL_METADATA, and CUSTOM_METADATA. Default is EXCLUDE_ALL_METADATA.

Declaration
[JsonProperty("metadata")]
public virtual string Metadata { get; set; }
Property Value
Type Description
string

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 [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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Network

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.

Declaration
[JsonProperty("network")]
public virtual string Network { get; set; }
Property Value
Type Description
string

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 setPrivateIpGoogleAccess.

Declaration
[JsonProperty("privateIpGoogleAccess")]
public virtual bool? PrivateIpGoogleAccess { get; set; }
Property Value
Type Description
bool?

PrivateIpv6GoogleAccess

This field is for internal use. This field can be both set at resource creation time and updated using patch.

Declaration
[JsonProperty("privateIpv6GoogleAccess")]
public virtual string PrivateIpv6GoogleAccess { get; set; }
Property Value
Type Description
string

Purpose

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.

Declaration
[JsonProperty("purpose")]
public virtual string Purpose { get; set; }
Property Value
Type Description
string

Region

URL of the region where the Subnetwork resides. This field can be set only at resource creation time.

Declaration
[JsonProperty("region")]
public virtual string Region { get; set; }
Property Value
Type Description
string

ReservedInternalRange

The URL of the reserved internal range.

Declaration
[JsonProperty("reservedInternalRange")]
public virtual string ReservedInternalRange { get; set; }
Property Value
Type Description
string

Role

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.

Declaration
[JsonProperty("role")]
public virtual string Role { get; set; }
Property Value
Type Description
string

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 patch request.

Declaration
[JsonProperty("secondaryIpRanges")]
public virtual IList<SubnetworkSecondaryRange> SecondaryIpRanges { get; set; }
Property Value
Type Description
IList<SubnetworkSecondaryRange>

[Output Only] Server-defined URL for the resource.

Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type Description
string

SelfLinkWithId

[Output Only] Server-defined URL for this resource with the resource id.

Declaration
[JsonProperty("selfLinkWithId")]
public virtual string SelfLinkWithId { get; set; }
Property Value
Type Description
string

StackType

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.

Declaration
[JsonProperty("stackType")]
public virtual string StackType { get; set; }
Property Value
Type Description
string

State

[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

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

Vlans

A repeated field indicating the VLAN IDs supported on this subnetwork. During Subnet creation, specifying vlan is valid only if enable_l2 is true. During Subnet Update, specifying vlan is allowed only for l2 enabled subnets. Restricted to only one VLAN.

Declaration
[JsonProperty("vlans")]
public virtual IList<int?> Vlans { get; set; }
Property Value
Type Description
IList<int?>

Implements