REST Resource: projects.locations.ipamAdminScopes

Resource: IpamAdminScope

Message describing IpamAdminScope object

JSON representation 
{
  "name": string,
  "enabledAddonPlatforms": [
    enum (AddOnPlatform)
  ],
  "scopes": [
    string
  ],
  "state": enum (DiscoveryPipelineState),
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  }
}
Fields
name

string

Required. Identifier. name of resource
enabledAddonPlatforms[]

enum (AddOnPlatform)

Required. Addon platforms that are enabled for this IPAM admin scope. Cloud Number Registry only discovers the IP addresses from the enabled platforms.
scopes[]

string

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

enum (DiscoveryPipelineState)

Output only. State of resource discovery pipeline.
createTime

string (Timestamp format)

Output only. [Output only] Create time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. [Output only] Update time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. Labels as key value pairs

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

AddOnPlatform

Enum for add-on platforms.

Enums
ADD_ON_PLATFORM_UNSPECIFIED Unspecified add-on platform.
COMPUTE_ENGINE Google Compute Engine.
GCE

Deprecated: Use COMPUTE_ENGINE instead.

DiscoveryPipelineState

Enum for IpamAdminScope discovery pipeline state.

Enums
DISCOVERY_PIPELINE_STATE_UNSPECIFIED Unspecified state.
INTERNAL_FAILURE Internal failure.
FAILED Failure.
SETUP_IN_PROGRESS Setup in progress.
READY_FOR_USE Ready for use.
DELETING_IN_PROGRESS Deleting in progress.
UPDATING Updating.
RECOVERING Recovering.
DISABLED Disabled.
DELETION_COMPLETED Deleting completed.
CLEANUP_IN_PROGRESS Cleanup in progress.
READY_FOR_DELETION Ready for deletion.

Methods

checkAvailability

 Checks the availability of IPAM admin scopes in a given project and location.

cleanup

 Cleans up a single IpamAdminScope.

create

 Creates a new IpamAdminScope in a given project and location.

delete

 Deletes a single IpamAdminScope.

disable

 Disables a single IpamAdminScope.

get

 Gets details of a single IpamAdminScope.

list

 List all IPAM admin scopes in a given project and location.

patch

 Updates the parameters of a single IpamAdminScope.