ipam_admin_scopes

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

Overview

Name	ipam_admin_scopes
Type	Resource
Id	google.cloudnumberregistry.ipam_admin_scopes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Required. Identifier. The resource name of the IpamAdminScope.
createTime	string (google-datetime)	Output only. The time at which the IpamAdminScope was created.
enabledAddonPlatforms	array	Required. Add-on platforms that are enabled for this IpamAdminScope. Cloud Number Registry only discovers the IP addresses from the enabled platforms.
labels	object	Optional. User-defined labels.
scopes	array	Required. Administrative scopes enabled for IP address discovery and management. For example, "organizations/1234567890". Minimum of 1 scope is required. In preview, only one organization scope is allowed.
state	string	Output only. State of resource discovery pipeline. (DISCOVERY_PIPELINE_STATE_UNSPECIFIED, INTERNAL_FAILURE, FAILED, SETUP_IN_PROGRESS, READY_FOR_USE, DELETING_IN_PROGRESS, UPDATING, RECOVERING, DISABLED, DELETION_COMPLETED, CLEANUP_IN_PROGRESS, READY_FOR_DELETION)
updateTime	string (google-datetime)	Output only. The time at which the IpamAdminScope was last updated.

list

Name	Datatype	Description
name	string	Required. Identifier. The resource name of the IpamAdminScope.
createTime	string (google-datetime)	Output only. The time at which the IpamAdminScope was created.
enabledAddonPlatforms	array	Required. Add-on platforms that are enabled for this IpamAdminScope. Cloud Number Registry only discovers the IP addresses from the enabled platforms.
labels	object	Optional. User-defined labels.
scopes	array	Required. Administrative scopes enabled for IP address discovery and management. For example, "organizations/1234567890". Minimum of 1 scope is required. In preview, only one organization scope is allowed.
state	string	Output only. State of resource discovery pipeline. (DISCOVERY_PIPELINE_STATE_UNSPECIFIED, INTERNAL_FAILURE, FAILED, SETUP_IN_PROGRESS, READY_FOR_USE, DELETING_IN_PROGRESS, UPDATING, RECOVERING, DISABLED, DELETION_COMPLETED, CLEANUP_IN_PROGRESS, READY_FOR_DELETION)
updateTime	string (google-datetime)	Output only. The time at which the IpamAdminScope was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, ipamAdminScopesId		Gets details of a single IpamAdminScope.
list	select	projectsId, locationsId	orderBy, pageToken, pageSize, filter	Lists IpamAdminScopes in a given project and location.
create	insert	projectsId, locationsId	ipamAdminScopeId, requestId	Creates a new IpamAdminScope in a given project and location.
patch	update	projectsId, locationsId, ipamAdminScopesId	updateMask, requestId	Updates the parameters of a single IpamAdminScope.
delete	delete	projectsId, locationsId, ipamAdminScopesId	requestId, force	Deletes a single IpamAdminScope.
disable	exec	projectsId, locationsId, ipamAdminScopesId		Disables a single IpamAdminScope.
check_availability	exec	projectsId, locationsId	scopes	Checks the availability of IpamAdminScopes in a given project and location.
cleanup	exec	projectsId, locationsId, ipamAdminScopesId		Cleans up a single IpamAdminScope.

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
ipamAdminScopesId	string
locationsId	string
projectsId	string
filter	string
force	boolean
ipamAdminScopeId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
scopes	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single IpamAdminScope.

SELECT
name,
createTime,
enabledAddonPlatforms,
labels,
scopes,
state,
updateTime
FROM google.cloudnumberregistry.ipam_admin_scopes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND ipamAdminScopesId = '{{ ipamAdminScopesId }}' -- required
;

list

Lists IpamAdminScopes in a given project and location.

SELECT
name,
createTime,
enabledAddonPlatforms,
labels,
scopes,
state,
updateTime
FROM google.cloudnumberregistry.ipam_admin_scopes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}'
;

INSERT examples

create

Creates a new IpamAdminScope in a given project and location.

INSERT INTO google.cloudnumberregistry.ipam_admin_scopes (
data__enabledAddonPlatforms,
data__scopes,
data__labels,
data__name,
projectsId,
locationsId,
ipamAdminScopeId,
requestId
)
SELECT 
'{{ enabledAddonPlatforms }}',
'{{ scopes }}',
'{{ labels }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ ipamAdminScopeId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: ipam_admin_scopes
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the ipam_admin_scopes resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the ipam_admin_scopes resource.
  - name: enabledAddonPlatforms
    value:
      - "{{ enabledAddonPlatforms }}"
    description: |
      Required. Add-on platforms that are enabled for this IpamAdminScope. Cloud Number Registry only discovers the IP addresses from the enabled platforms.
  - name: scopes
    value:
      - "{{ scopes }}"
    description: |
      Required. Administrative scopes enabled for IP address discovery and management. For example, "organizations/1234567890". Minimum of 1 scope is required. In preview, only one organization scope is allowed.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. User-defined labels.
  - name: name
    value: "{{ name }}"
    description: |
      Required. Identifier. The resource name of the IpamAdminScope.
  - name: ipamAdminScopeId
    value: "{{ ipamAdminScopeId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates the parameters of a single IpamAdminScope.

UPDATE google.cloudnumberregistry.ipam_admin_scopes
SET 
data__enabledAddonPlatforms = '{{ enabledAddonPlatforms }}',
data__scopes = '{{ scopes }}',
data__labels = '{{ labels }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND ipamAdminScopesId = '{{ ipamAdminScopesId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single IpamAdminScope.

DELETE FROM google.cloudnumberregistry.ipam_admin_scopes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND ipamAdminScopesId = '{{ ipamAdminScopesId }}' --required
AND requestId = '{{ requestId }}'
AND force = '{{ force }}'
;

Lifecycle Methods

disable

Disables a single IpamAdminScope.

EXEC google.cloudnumberregistry.ipam_admin_scopes.disable 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@ipamAdminScopesId='{{ ipamAdminScopesId }}' --required 
@@json=
'{
"requestId": "{{ requestId }}"
}'
;

check_availability

Checks the availability of IpamAdminScopes in a given project and location.

EXEC google.cloudnumberregistry.ipam_admin_scopes.check_availability 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@scopes='{{ scopes }}'
;

cleanup

Cleans up a single IpamAdminScope.

EXEC google.cloudnumberregistry.ipam_admin_scopes.cleanup 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@ipamAdminScopesId='{{ ipamAdminScopesId }}' --required 
@@json=
'{
"requestId": "{{ requestId }}"
}'
;