google-native logo
Google Cloud Native v0.28.0, Feb 2 23

google-native.cloudresourcemanager/v3.getTagKey

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

Using getTagKey

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTagKey(args: GetTagKeyArgs, opts?: InvokeOptions): Promise<GetTagKeyResult>
function getTagKeyOutput(args: GetTagKeyOutputArgs, opts?: InvokeOptions): Output<GetTagKeyResult>
def get_tag_key(tag_key_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetTagKeyResult
def get_tag_key_output(tag_key_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetTagKeyResult]
func LookupTagKey(ctx *Context, args *LookupTagKeyArgs, opts ...InvokeOption) (*LookupTagKeyResult, error)
func LookupTagKeyOutput(ctx *Context, args *LookupTagKeyOutputArgs, opts ...InvokeOption) LookupTagKeyResultOutput

> Note: This function is named LookupTagKey in the Go SDK.

public static class GetTagKey 
{
    public static Task<GetTagKeyResult> InvokeAsync(GetTagKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetTagKeyResult> Invoke(GetTagKeyInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetTagKeyResult> getTagKey(GetTagKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: google-native:cloudresourcemanager/v3:getTagKey
  arguments:
    # arguments dictionary

The following arguments are supported:

TagKeyId string
TagKeyId string
tagKeyId String
tagKeyId string
tagKeyId String

getTagKey Result

The following output properties are available:

CreateTime string

Creation time.

Description string

Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.

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.

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.

NamespacedName string

Immutable. Namespaced name of the TagKey.

Parent string

Immutable. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id}.

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 Dictionary<string, string>

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

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

Update time.

CreateTime string

Creation time.

Description string

Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.

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.

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.

NamespacedName string

Immutable. Namespaced name of the TagKey.

Parent string

Immutable. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id}.

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 map[string]string

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

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

Update time.

createTime String

Creation time.

description String

Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.

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.

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.

namespacedName String

Immutable. Namespaced name of the TagKey.

parent String

Immutable. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id}.

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 Map<String,String>

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

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

Update time.

createTime string

Creation time.

description string

Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.

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.

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.

namespacedName string

Immutable. Namespaced name of the TagKey.

parent string

Immutable. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id}.

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 {[key: string]: string}

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

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

Update time.

create_time str

Creation time.

description str

Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.

etag str

Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.

name str

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.

namespaced_name str

Immutable. Namespaced name of the TagKey.

parent str

Immutable. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id}.

purpose str

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.

purpose_data Mapping[str, str]

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.

short_name str

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.

update_time str

Update time.

createTime String

Creation time.

description String

Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.

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.

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.

namespacedName String

Immutable. Namespaced name of the TagKey.

parent String

Immutable. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id}.

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 Map<String>

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

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

Update time.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0