gcloud alpha kms single-tenant-hsm describe

NAME

gcloud alpha kms single-tenant-hsm describe - get metadata for a single tenant HSM instance

SYNOPSIS

gcloud alpha kms single-tenant-hsm describe (SINGLE_TENANT_HSM_INSTANCE : --location=LOCATION) [GCLOUD_WIDE_FLAG …]

DESCRIPTION

(ALPHA) Returns metadata for the given single tenant HSM instance.

## EXAMPLES

The following command returns the metadata for the single tenant HSM instance with the name my_sthi in the location us-east1`using the fully specified name:

gcloud alpha kms single-tenant-hsm describe
projects/my-project/locations/us-east1/singleTenantHsmInstances/mysthi

The following command returns the metadata for the singletenanthsm instance with the name mysthi in the location us-east1 using the location and resource id:

gcloud alpha kms single-tenant-hsm describe mysthi --location=us-east1

POSITIONAL ARGUMENTS

SingleTenantHsmInstance resource - The KMS single tenant HSM instance resource. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.

To set the project attribute:

• provide the argument single_tenant_hsm_instance on the command line with a fully specified name;
• set the property core/project.

This must be specified.

SINGLE_TENANT_HSM_INSTANCE

ID of the singleTenantHsmInstance or fully qualified identifier for the singleTenantHsmInstance.

To set the single_tenant_hsm_instance attribute:

• provide the argument single_tenant_hsm_instance on the command line.

This positional argument must be specified if any of the other arguments in this group are specified.

--location=LOCATION

The Google Cloud location for the singleTenantHsmInstance.

To set the location attribute:

• provide the argument single_tenant_hsm_instance on the command line with a fully specified name;
• provide the argument --location on the command line.

GCLOUD WIDE FLAGS

These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

NOTES

This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. These variants are also available:

gcloud kms single-tenant-hsm describe

gcloud beta kms single-tenant-hsm describe