internal_ranges

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

Overview

Name	internal_ranges
Type	Resource
Id	google.networkconnectivity.internal_ranges

Fields

Name	Datatype	Description
name	string	Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names
description	string	A description of this resource.
createTime	string	Time when the internal range was created.
ipCidrRange	string	The IP range that this internal range defines.
labels	object	User-defined labels.
network	string	The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. For example: https://www.googleapis.com/compute/v1/projects/{project}/locations/global/networks/{network} projects/{project}/locations/global/networks/{network} {network}
overlaps	array	Optional. Types of resources that are allowed to overlap with the current internal range.
peering	string	The type of peering set for this internal range.
prefixLength	integer	An alternate to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size.
targetCidrRange	array	Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.
updateTime	string	Time when the internal range was updated.
usage	string	The type of usage set for this InternalRange.
users	array	Output only. The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range referred to. Can be empty.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	internalRangesId, locationsId, projectsId	Gets details of a single internal range.
list	SELECT	locationsId, projectsId	Lists internal ranges in a given project and location.
create	INSERT	locationsId, projectsId	Creates a new internal range in a given project and location.
delete	DELETE	internalRangesId, locationsId, projectsId	Deletes a single internal range.
patch	UPDATE	internalRangesId, locationsId, projectsId	Updates the parameters of a single internal range.

SELECT examples

Lists internal ranges in a given project and location.

SELECT
name,
description,
createTime,
ipCidrRange,
labels,
network,
overlaps,
peering,
prefixLength,
targetCidrRange,
updateTime,
usage,
users
FROM google.networkconnectivity.internal_ranges
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new internal_ranges resource.

All Properties

/*+ create */
INSERT INTO google.networkconnectivity.internal_ranges (
locationsId,
projectsId,
name,
labels,
description,
ipCidrRange,
network,
usage,
peering,
prefixLength,
targetCidrRange,
overlaps
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ labels }}',
'{{ description }}',
'{{ ipCidrRange }}',
'{{ network }}',
'{{ usage }}',
'{{ peering }}',
'{{ prefixLength }}',
'{{ targetCidrRange }}',
'{{ overlaps }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: description
      value: string
    - name: ipCidrRange
      value: string
    - name: network
      value: string
    - name: usage
      value: string
    - name: peering
      value: string
    - name: prefixLength
      value: integer
    - name: targetCidrRange
      value:
        - string
    - name: users
      value:
        - string
    - name: overlaps
      value:
        - string

UPDATE example

Updates a internal_ranges resource.

/*+ update */
UPDATE google.networkconnectivity.internal_ranges
SET 
name = '{{ name }}',
labels = '{{ labels }}',
description = '{{ description }}',
ipCidrRange = '{{ ipCidrRange }}',
network = '{{ network }}',
usage = '{{ usage }}',
peering = '{{ peering }}',
prefixLength = '{{ prefixLength }}',
targetCidrRange = '{{ targetCidrRange }}',
overlaps = '{{ overlaps }}'
WHERE 
internalRangesId = '{{ internalRangesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified internal_ranges resource.

/*+ delete */
DELETE FROM google.networkconnectivity.internal_ranges
WHERE internalRangesId = '{{ internalRangesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';