Skip to main content

addresses

Creates, updates, deletes, gets or lists an addresses resource.

Overview​

Nameaddresses
TypeResource
Idgoogle.compute.addresses

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.
namestringName of the resource. Provided by the client when the resource is created. 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
addressstringThe static IP address represented by this resource.
addressTypestringThe type of address to reserve, either INTERNAL orEXTERNAL. If unspecified, defaults to EXTERNAL. (EXTERNAL, INTERNAL, UNSPECIFIED_TYPE)
creationTimestampstringOutput only. [Output Only] Creation timestamp inRFC3339 text format.
descriptionstringAn optional description of this resource. Provide this field when you create the resource.
ipCollectionstringReference to the source of IP addresses. It supports the following cases: - Case 1: PublicDelegatedPrefix (PDP) for BYOIP external addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 allocations. If an IPv6 PDP is used, the PDP must be in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. - Case 2: Internal Range for global internal addresses. Use one of the following formats to specify the resource: For a Public Delegated Prefix: - Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp - Partial URL: - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name For an Internal Range: - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range - Partial URL:projects/project/locations/global/internalRanges/internal-range
ipVersionstringThe IP version that will be used by this address. Valid options areIPV4 or IPV6. (IPV4, IPV6, UNSPECIFIED_VERSION)
ipv6EndpointTypestringThe endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. (NETLB, VM)
kindstringOutput only. [Output Only] Type of the resource. Always compute#address for addresses. (default: compute#address)
labelFingerprintstring (byte)A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
labelsobjectLabels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
networkstringThe URL of the network in which to reserve the address. This field can only be used with INTERNAL type with theVPC_PEERING purpose.
networkTierstringThis signifies the networking tier used for configuring this address and can only take the following values: PREMIUM orSTANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. (FIXED_STANDARD, PREMIUM, STANDARD, STANDARD_OVERRIDES_FIXED_STANDARD)
prefixLengthinteger (int32)The prefix length if the resource represents an IP range.
purposestringThe purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. - PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0 for addresses that can only be assigned to global external Passthrough Network Load Balancer forwarding rules, as an Availability Group 0 address. - PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1 for addresses that can only be assigned to global external Passthrough Network Load Balancer forwarding rules, as an Availability Group 1 address. (DNS_RESOLVER, GCE_ENDPOINT, IPSEC_INTERCONNECT, NAT_AUTO, PRIVATE_SERVICE_CONNECT, SERVERLESS, SHARED_LOADBALANCER_VIP, VPC_PEERING)
regionstringOutput only. [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.
selfLinkstring[Output Only] Server-defined URL for the resource.
statusstringOutput only. [Output Only] The status of the address, which can be one ofRESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. (IN_USE, RESERVED, RESERVING)
subnetworkstringThe URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with aGCE_ENDPOINT or DNS_RESOLVER purpose.
usersarray[Output Only] The URLs of the resources that are using this address.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectproject, region, addressReturns the specified address resource.
listselectproject, regionorderBy, maxResults, pageToken, filter, returnPartialSuccessRetrieves a list of addresses contained within
the specified region.
aggregated_listselectprojectfilter, serviceProjectNumber, maxResults, pageToken, includeAllScopes, orderBy, returnPartialSuccessRetrieves an aggregated list of addresses.

To prevent failure, it is recommended that you set the
returnPartialSuccess parameter to true.
insertinsertproject, regionrequestIdCreates an address resource in the specified project by using the data
included in the request.
deletedeleteproject, region, addressrequestIdDeletes the specified address resource.
set_labelsexecproject, region, resourcerequestIdSets the labels on an Address. To learn more about labels, read theLabeling
Resources documentation.
moveexecproject, region, addressrequestIdMoves the specified address resource.

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
addressstring
projectstring
regionstring
resourcestring
filterstring
includeAllScopesboolean
maxResultsinteger (uint32)
orderBystring
pageTokenstring
requestIdstring
returnPartialSuccessboolean
serviceProjectNumberstring (int64)

SELECT examples​

Returns the specified address resource.

SELECT
id,
name,
address,
addressType,
creationTimestamp,
description,
ipCollection,
ipVersion,
ipv6EndpointType,
kind,
labelFingerprint,
labels,
network,
networkTier,
prefixLength,
purpose,
region,
selfLink,
status,
subnetwork,
users
FROM google.compute.addresses
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND address = '{{ address }}' -- required
;

INSERT examples​

Creates an address resource in the specified project by using the data
included in the request.

INSERT INTO google.compute.addresses (
data__name,
data__ipVersion,
data__purpose,
data__addressType,
data__labelFingerprint,
data__labels,
data__description,
data__networkTier,
data__ipCollection,
data__selfLink,
data__address,
data__users,
data__prefixLength,
data__ipv6EndpointType,
data__subnetwork,
data__network,
project,
region,
requestId
)
SELECT 
'{{ name }}',
'{{ ipVersion }}',
'{{ purpose }}',
'{{ addressType }}',
'{{ labelFingerprint }}',
'{{ labels }}',
'{{ description }}',
'{{ networkTier }}',
'{{ ipCollection }}',
'{{ selfLink }}',
'{{ address }}',
'{{ users }}',
{{ prefixLength }},
'{{ ipv6EndpointType }}',
'{{ subnetwork }}',
'{{ network }}',
'{{ 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
;

DELETE examples​

Deletes the specified address resource.

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

Lifecycle Methods​

Sets the labels on an Address. To learn more about labels, read theLabeling
Resources documentation.

EXEC google.compute.addresses.set_labels 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@resource='{{ resource }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"labels": "{{ labels }}", 
"labelFingerprint": "{{ labelFingerprint }}"
}'
;