Skip to main content

tag_keys_namespaced

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

Overview

Nametag_keys_namespaced
TypeResource
Idgoogle.cloudresourcemanager.tag_keys_namespaced

Fields

NameDatatypeDescription
namestringImmutable. The resource name for a TagKey. Must be in the format tagKeys/{tag_key_id}, where tag_key_id is the generated numeric id for the TagKey.
descriptionstringOptional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.
createTimestringOutput only. Creation time.
etagstringOptional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
namespacedNamestringOutput only. Immutable. Namespaced name of the TagKey.
parentstringImmutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form organizations/{org_id}. For a TagKey parented by a Project, its parent can be in the form projects/{project_id} or projects/{project_number}.
purposestringOptional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.
purposeDataobjectOptional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for Purpose for formatting of this field. Purpose data cannot be changed once set.
shortNamestringRequired. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
updateTimestringOutput only. Update time.

Methods

NameAccessible byRequired ParamsDescription
get_namespacedSELECTRetrieves a TagKey by its namespaced name. This method will return PERMISSION_DENIED if the key does not exist or the user does not have permission to view it.

SELECT examples

Retrieves a TagKey by its namespaced name. This method will return PERMISSION_DENIED if the key does not exist or the user does not have permission to view it.

SELECT
name,
description,
createTime,
etag,
namespacedName,
parent,
purpose,
purposeData,
shortName,
updateTime
FROM google.cloudresourcemanager.tag_keys_namespaced
;