gcloud beta redis instances get-auth-string

NAME
gcloud beta redis instances get-auth-string - show AUTH string for a Memorystore Redis instance
SYNOPSIS
gcloud beta redis instances get-auth-string(INSTANCE :--region=REGION)[GCLOUD_WIDE_FLAG]
DESCRIPTION
(BETA) Show AUTH string for a Memorystore Redis instance.

Result is empty if AUTH is disabled for the instance.

This command can fail for the following reasons:

  • The instance specified does not exist.
  • The active account does not have permission to view the AUTH string
EXAMPLES
To display the AUTH string for an instance with the namemy-redis-instance in the default region, run:
gcloudbetaredisinstancesget-auth-stringmy-redis-instance
POSITIONAL ARGUMENTS
Instance resource - Arguments and flags that specify the Memorystore Redisinstance you want to view the AUTH string for. The arguments in this group canbe used to specify the attributes of this resource. (NOTE) Some attributes arenot given arguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentinstance on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

INSTANCE
ID of the instance or fully qualified identifier for the instance.

To set theinstance attribute:

  • provide the argumentinstance on the command line.

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

--region=REGION
The name of the Redis region of the instance. Overrides the default redis/regionproperty value for this command invocation.To set theregion attribute:
  • provide the argumentinstance on the command line with a fullyspecified name;
  • provide the argument--region on the command line;
  • set the propertyredis/region.
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.

API REFERENCE
This command uses theredis/v1beta1 API. The full documentation forthis API can be found at:https://cloud.google.com/memorystore/docs/redis/
NOTES
This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudredisinstancesget-auth-string
gcloudalpharedisinstancesget-auth-string

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-07 UTC.