tag_keys_namespaced
Creates, updates, deletes, gets or lists a tag_keys_namespaced
resource.
Overview
Name | tag_keys_namespaced |
Type | Resource |
Id | google.cloudresourcemanager.tag_keys_namespaced |
Fields
Name | Datatype | Description |
---|---|---|
name | string | Immutable. 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. |
description | string | Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write. |
createTime | string | Output only. Creation time. |
etag | string | Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details. |
namespacedName | string | Output only. Immutable. Namespaced name of the TagKey. |
parent | string | Immutable. 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} . |
purpose | string | Optional. 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. |
purposeData | object | Optional. 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. |
shortName | string | Required. 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. |
updateTime | string | Output only. Update time. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get_namespaced | SELECT |
| 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
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
;