gcloud redis instances get-auth-string Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud redis instances get-auth-string - show AUTH string for a Memorystore Redis instance
- SYNOPSIS
gcloud redis instances get-auth-string(INSTANCE:--region=REGION)[GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- 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 name
my-redis-instancein the default region, run:gcloudredisinstancesget-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 the
projectattribute:- provide the argument
instanceon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
INSTANCE- ID of the instance or fully qualified identifier for the instance.
To set the
instanceattribute:- provide the argument
instanceon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--region=REGION- The name of the Redis region of the instance. Overrides the default redis/regionproperty value for this command invocation.To set the
regionattribute:- provide the argument
instanceon the command line with a fullyspecified name; - provide the argument
--regionon the command line; - set the property
redis/region.
- provide the argument
- provide the argument
- 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.
- 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 helpfor details. - API REFERENCE
- This command uses the
redis/v1API. The full documentation for thisAPI can be found at:https://cloud.google.com/memorystore/docs/redis/ - NOTES
- These variants are also available:
gcloudalpharedisinstancesget-auth-stringgcloudbetaredisinstancesget-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.