discovered_ranges

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

Overview

Name	discovered_ranges
Type	Resource
Id	google.cloudnumberregistry.discovered_ranges

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Required. Identifier. The resource name of the DiscoveredRange, in the format projects/{project}/locations/{location}/discoveredRanges/{discovered_range}.
attributes	array	Optional. The attributes of the DiscoveredRange.
childCidrOverlapAllowed	boolean	Output only. If true, allows child DiscoveredRanges of this DiscoveredRange to overlap with each other.
createTime	string (google-datetime)	Output only. The time at which the DiscoveredRange was created.
description	string	Optional. Description of the DiscoveredRange.
discoveryMetadata	object	Output only. Owner metadata for this DiscoveredRange. A unique set of metadata is associated with each DiscoveredRange. If an IP range is shared by multiple resources (e.g., an Address resource and an Instance resource, or multiple ForwardingRules),separate DiscoveredRanges are created, each with a distinct owner. This ensures each DiscoveredRange has its own unique set of attributes, labels, create time and update time. (id: DiscoveryMetadata)
ipv4CidrRange	string	Optional. The IPv4 CIDR range of the DiscoveredRange.
ipv6CidrRange	string	Optional. The IPv6 CIDR range of the DiscoveredRange.
labels	object	Optional. User-defined labels.
parentRange	string	Optional. The resource name of the parent DiscoveredRange, in the format projects/{project}/locations/{location}/discoveredRanges/{discovered_range}.
realm	string	Optional. The Realm of the DiscoveredRange.
registryBook	string	Output only. The RegistryBook of the DiscoveredRange.
updateTime	string (google-datetime)	Output only. The time at which the DiscoveredRange was last updated.

list

Name	Datatype	Description
name	string	Required. Identifier. The resource name of the DiscoveredRange, in the format projects/{project}/locations/{location}/discoveredRanges/{discovered_range}.
attributes	array	Optional. The attributes of the DiscoveredRange.
childCidrOverlapAllowed	boolean	Output only. If true, allows child DiscoveredRanges of this DiscoveredRange to overlap with each other.
createTime	string (google-datetime)	Output only. The time at which the DiscoveredRange was created.
description	string	Optional. Description of the DiscoveredRange.
discoveryMetadata	object	Output only. Owner metadata for this DiscoveredRange. A unique set of metadata is associated with each DiscoveredRange. If an IP range is shared by multiple resources (e.g., an Address resource and an Instance resource, or multiple ForwardingRules),separate DiscoveredRanges are created, each with a distinct owner. This ensures each DiscoveredRange has its own unique set of attributes, labels, create time and update time. (id: DiscoveryMetadata)
ipv4CidrRange	string	Optional. The IPv4 CIDR range of the DiscoveredRange.
ipv6CidrRange	string	Optional. The IPv6 CIDR range of the DiscoveredRange.
labels	object	Optional. User-defined labels.
parentRange	string	Optional. The resource name of the parent DiscoveredRange, in the format projects/{project}/locations/{location}/discoveredRanges/{discovered_range}.
realm	string	Optional. The Realm of the DiscoveredRange.
registryBook	string	Output only. The RegistryBook of the DiscoveredRange.
updateTime	string (google-datetime)	Output only. The time at which the DiscoveredRange was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, discoveredRangesId		Gets details of a single DiscoveredRange.
list	select	projectsId, locationsId	filter, pageSize, orderBy, pageToken	Lists DiscoveredRanges in a given project and location.
find_free_ip_ranges	exec	projectsId, locationsId, discoveredRangesId	rangeCount, requestId, cidrPrefixLength	Finds free IP ranges in a single DiscoveredRange.
show_utilization	exec	projectsId, locationsId, discoveredRangesId		Gets the details of a single DiscoveredRange and its utilization.

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
discoveredRangesId	string
locationsId	string
projectsId	string
cidrPrefixLength	integer (int32)
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
rangeCount	integer (int32)
requestId	string

SELECT examples

get

Gets details of a single DiscoveredRange.

SELECT
name,
attributes,
childCidrOverlapAllowed,
createTime,
description,
discoveryMetadata,
ipv4CidrRange,
ipv6CidrRange,
labels,
parentRange,
realm,
registryBook,
updateTime
FROM google.cloudnumberregistry.discovered_ranges
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND discoveredRangesId = '{{ discoveredRangesId }}' -- required
;

list

Lists DiscoveredRanges in a given project and location.

SELECT
name,
attributes,
childCidrOverlapAllowed,
createTime,
description,
discoveryMetadata,
ipv4CidrRange,
ipv6CidrRange,
labels,
parentRange,
realm,
registryBook,
updateTime
FROM google.cloudnumberregistry.discovered_ranges
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
;

Lifecycle Methods

find_free_ip_ranges

Finds free IP ranges in a single DiscoveredRange.

EXEC google.cloudnumberregistry.discovered_ranges.find_free_ip_ranges 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@discoveredRangesId='{{ discoveredRangesId }}' --required, 
@rangeCount='{{ rangeCount }}', 
@requestId='{{ requestId }}', 
@cidrPrefixLength='{{ cidrPrefixLength }}'
;

show_utilization

Gets the details of a single DiscoveredRange and its utilization.

EXEC google.cloudnumberregistry.discovered_ranges.show_utilization 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@discoveredRangesId='{{ discoveredRangesId }}' --required
;