REST Resource: projects.locations.privateClouds.hcxActivationKeys

Resource: HcxActivationKey

HCX activation key. A default key is created during private cloud provisioning, but this behavior is subject to change and you should always verify active keys. Use VmwareEngine.ListHcxActivationKeys to retrieve existing keys and VmwareEngine.CreateHcxActivationKey to create new ones.

JSON representation
{
  "name": string,
  "createTime": string,
  "state": enum (State),
  "activationKey": string,
  "uid": string
}
Fields
name

string

Output only. The resource name of this HcxActivationKey. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateClouds/my-cloud/hcxActivationKeys/my-key

createTime

string (Timestamp format)

Output only. Creation time of HCX activation key.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Output only. State of HCX activation key.

activationKey

string

Output only. HCX activation key.

uid

string

Output only. System-generated unique identifier for the resource.

State

State of HCX activation key

Enums
STATE_UNSPECIFIED Unspecified state.
AVAILABLE State of a newly generated activation key.
CONSUMED State of key when it has been used to activate HCX appliance.
CREATING State of key when it is being created.

Methods

create

Creates a new HCX activation key in a given private cloud.

get

Retrieves a HcxActivationKey resource by its resource name.

getIamPolicy

Gets the access control policy for a resource.

list

Lists HcxActivationKey resources in a given private cloud.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.