hcx_activation_keys

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

Overview

Name	hcx_activation_keys
Type	Resource
Id	google.vmwareengine.hcx_activation_keys

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
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
activationKey	string	Output only. HCX activation key.
createTime	string (google-datetime)	Output only. Creation time of HCX activation key.
state	string	Output only. State of HCX activation key.
uid	string	Output only. System-generated unique identifier for the resource.

list

Successful response

Name	Datatype	Description
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
activationKey	string	Output only. HCX activation key.
createTime	string (google-datetime)	Output only. Creation time of HCX activation key.
state	string	Output only. State of HCX activation key.
uid	string	Output only. System-generated unique identifier for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, privateCloudsId, hcxActivationKeysId		Retrieves a HcxActivationKey resource by its resource name.
list	select	projectsId, locationsId, privateCloudsId	pageSize, pageToken	Lists HcxActivationKey resources in a given private cloud.
create	insert	projectsId, locationsId, privateCloudsId	hcxActivationKeyId, requestId	Creates a new HCX activation key in a given private cloud.

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
hcxActivationKeysId	string
locationsId	string
privateCloudsId	string
projectsId	string
hcxActivationKeyId	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Retrieves a HcxActivationKey resource by its resource name.

SELECT
name,
activationKey,
createTime,
state,
uid
FROM google.vmwareengine.hcx_activation_keys
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND hcxActivationKeysId = '{{ hcxActivationKeysId }}' -- required;

list

Lists HcxActivationKey resources in a given private cloud.

SELECT
name,
activationKey,
createTime,
state,
uid
FROM google.vmwareengine.hcx_activation_keys
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

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

INSERT INTO google.vmwareengine.hcx_activation_keys (
projectsId,
locationsId,
privateCloudsId,
hcxActivationKeyId,
requestId
)
SELECT 
'{{ projectsId }}',
'{{ locationsId }}',
'{{ privateCloudsId }}',
'{{ hcxActivationKeyId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: hcx_activation_keys
  props:
    - name: projectsId
      value: string
      description: Required parameter for the hcx_activation_keys resource.
    - name: locationsId
      value: string
      description: Required parameter for the hcx_activation_keys resource.
    - name: privateCloudsId
      value: string
      description: Required parameter for the hcx_activation_keys resource.
    - name: hcxActivationKeyId
      value: string
    - name: requestId
      value: string