addresses

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

Overview

Name	addresses
Type	Resource
Id	google.compute.addresses

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	Name of the resource. Provided by the client when the resource is created. 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])?. 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?)
address	string	The static IP address represented by this resource.
addressType	string	The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
description	string	An optional description of this resource. Provide this field when you create the resource.
ipVersion	string	The IP version that will be used by this address. Valid options are IPV4 or IPV6.
ipv6EndpointType	string	The 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.
kind	string	[Output Only] Type of the resource. Always compute#address for addresses. (default: compute#address)
labelFingerprint	string (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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
labels	object	Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
network	string	The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
networkTier	string	This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. 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.
prefixLength	integer (int32)	The prefix length if the resource represents an IP range.
purpose	string	The 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.
region	string	[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.
selfLink	string	[Output Only] Server-defined URL for the resource.
status	string	[Output Only] The status of the address, which can be one of RESERVING, 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.
subnetwork	string	The 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 a GCE_ENDPOINT or DNS_RESOLVER purpose.
users	array	[Output Only] The URLs of the resources that are using this address.

list

Successful response

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of Address resources.
kind	string	[Output Only] Type of resource. Always compute#addressList for lists of addresses. (default: compute#addressList)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	[Output Only] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

aggregated_list

Successful response

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	Name of the resource. Provided by the client when the resource is created. 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])?. 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?)
address	string	The static IP address represented by this resource.
addressType	string	The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
description	string	An optional description of this resource. Provide this field when you create the resource.
ipVersion	string	The IP version that will be used by this address. Valid options are IPV4 or IPV6.
ipv6EndpointType	string	The 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.
kind	string	[Output Only] Type of the resource. Always compute#address for addresses. (default: compute#address)
labelFingerprint	string (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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
labels	object	Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
network	string	The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
networkTier	string	This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. 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.
prefixLength	integer (int32)	The prefix length if the resource represents an IP range.
purpose	string	The 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.
region	string	[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.
selfLink	string	[Output Only] Server-defined URL for the resource.
status	string	[Output Only] The status of the address, which can be one of RESERVING, 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.
subnetwork	string	The 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 a GCE_ENDPOINT or DNS_RESOLVER purpose.
users	array	[Output Only] The URLs of the resources that are using this address.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, region, address		Returns the specified address resource.
list	select	project, region	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves a list of addresses contained within the specified region.
aggregated_list	select	project	filter, includeAllScopes, maxResults, orderBy, pageToken, returnPartialSuccess, serviceProjectNumber	Retrieves an aggregated list of addresses. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
insert	insert	project, region	requestId	Creates an address resource in the specified project by using the data included in the request.
delete	delete	project, region, address	requestId	Deletes the specified address resource.
move	exec	project, region, address	requestId	Moves the specified address resource.
set_labels	exec	project, region, resource	requestId	Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation.

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.

Name	Datatype	Description
address	string
project	string
region	string
resource	string
filter	string
includeAllScopes	boolean
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean
serviceProjectNumber	string (int64)

SELECT examples

get

Returns the specified address resource.

SELECT
id,
name,
address,
addressType,
creationTimestamp,
description,
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;

list

Retrieves a list of addresses contained within the specified region.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.addresses
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

aggregated_list

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

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

INSERT examples

insert

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

INSERT INTO google.compute.addresses (
data__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__address,
data__prefixLength,
data__status,
data__region,
data__selfLink,
data__users,
data__networkTier,
data__labels,
data__labelFingerprint,
data__ipVersion,
data__addressType,
data__purpose,
data__subnetwork,
data__network,
data__ipv6EndpointType,
project,
region,
requestId
)
SELECT 
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ address }}',
{{ prefixLength }},
'{{ status }}',
'{{ region }}',
'{{ selfLink }}',
'{{ users }}',
'{{ networkTier }}',
'{{ labels }}',
'{{ labelFingerprint }}',
'{{ ipVersion }}',
'{{ addressType }}',
'{{ purpose }}',
'{{ subnetwork }}',
'{{ network }}',
'{{ ipv6EndpointType }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: addresses
  props:
    - name: project
      value: string
      description: Required parameter for the addresses resource.
    - name: region
      value: string
      description: Required parameter for the addresses resource.
    - name: kind
      value: string
      description: >
        [Output Only] Type of the resource. Always compute#address for addresses.
        
      default: compute#address
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        Name of the resource. Provided by the client when the resource is created. 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])?`. 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.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this field when you create the resource.
        
    - name: address
      value: string
      description: >
        The static IP address represented by this resource.
        
    - name: prefixLength
      value: integer
      description: >
        The prefix length if the resource represents an IP range.
        
    - name: status
      value: string
      description: >
        [Output Only] The status of the address, which can be one of RESERVING, 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.
        
      valid_values: ['IN_USE', 'RESERVED', 'RESERVING']
    - name: region
      value: string
      description: >
        [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.*
        
    - name: selfLink
      value: string
      description: >
        [Output Only] Server-defined URL for the resource.
        
    - name: users
      value: array
      description: >
        [Output Only] The URLs of the resources that are using this address.
        
    - name: networkTier
      value: string
      description: >
        This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. 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.
        
      valid_values: ['FIXED_STANDARD', 'PREMIUM', 'STANDARD', 'STANDARD_OVERRIDES_FIXED_STANDARD']
    - name: labels
      value: object
      description: >
        Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        
    - name: labelFingerprint
      value: string
      description: >
        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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
        
    - name: ipVersion
      value: string
      description: >
        The IP version that will be used by this address. Valid options are IPV4 or IPV6.
        
      valid_values: ['IPV4', 'IPV6', 'UNSPECIFIED_VERSION']
    - name: addressType
      value: string
      description: >
        The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
        
      valid_values: ['EXTERNAL', 'INTERNAL', 'UNSPECIFIED_TYPE']
    - name: purpose
      value: string
      description: >
        The 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. 
        
      valid_values: ['DNS_RESOLVER', 'GCE_ENDPOINT', 'IPSEC_INTERCONNECT', 'NAT_AUTO', 'PRIVATE_SERVICE_CONNECT', 'SERVERLESS', 'SHARED_LOADBALANCER_VIP', 'VPC_PEERING']
    - name: subnetwork
      value: string
      description: >
        The 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 a GCE_ENDPOINT or DNS_RESOLVER purpose.
        
    - name: network
      value: string
      description: >
        The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
        
    - name: ipv6EndpointType
      value: string
      description: >
        The 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.
        
      valid_values: ['NETLB', 'VM']
    - name: requestId
      value: string

DELETE examples

delete

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

move

Moves the specified address resource.

EXEC google.compute.addresses.move 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@address='{{ address }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"destinationAddress": "{{ destinationAddress }}", 
"description": "{{ description }}"
}';

set_labels

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

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