Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.sqladmin/v1.getUser
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Retrieves a resource containing information about a user.
Using getUser
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 getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOptions): Output<GetUserResult>
def get_user(host: Optional[str] = None,
instance: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(host: Optional[pulumi.Input[str]] = None,
instance: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput
> Note: This function is named LookupUser
in the Go SDK.
public static class GetUser
{
public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:sqladmin/v1:getUser
arguments:
# arguments dictionary
The following arguments are supported:
getUser Result
The following output properties are available:
- Dual
Password stringType Dual password status for the user.
- Etag string
This field is deprecated and will be removed from a future version of the API.
This field is deprecated and will be removed from a future version of the API.
- Host string
Optional. The host from which the user can connect. For
insert
operations, host defaults to an empty string. Forupdate
operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.- Instance string
The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for
update
because it is already specified on the URL.- Kind string
This is always
sql#user
.- Name string
The name of the user in the Cloud SQL instance. Can be omitted for
update
because it is already specified in the URL.- Password string
The password for the user.
- Password
Policy Pulumi.Google Native. SQLAdmin. V1. Outputs. User Password Validation Policy Response User level password validation policy.
- Project string
The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for
update
because it is already specified on the URL.- Sqlserver
User Pulumi.Details Google Native. SQLAdmin. V1. Outputs. Sql Server User Details Response - Type string
The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
- Dual
Password stringType Dual password status for the user.
- Etag string
This field is deprecated and will be removed from a future version of the API.
This field is deprecated and will be removed from a future version of the API.
- Host string
Optional. The host from which the user can connect. For
insert
operations, host defaults to an empty string. Forupdate
operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.- Instance string
The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for
update
because it is already specified on the URL.- Kind string
This is always
sql#user
.- Name string
The name of the user in the Cloud SQL instance. Can be omitted for
update
because it is already specified in the URL.- Password string
The password for the user.
- Password
Policy UserPassword Validation Policy Response User level password validation policy.
- Project string
The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for
update
because it is already specified on the URL.- Sqlserver
User SqlDetails Server User Details Response - Type string
The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
- dual
Password StringType Dual password status for the user.
- etag String
This field is deprecated and will be removed from a future version of the API.
This field is deprecated and will be removed from a future version of the API.
- host String
Optional. The host from which the user can connect. For
insert
operations, host defaults to an empty string. Forupdate
operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.- instance String
The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for
update
because it is already specified on the URL.- kind String
This is always
sql#user
.- name String
The name of the user in the Cloud SQL instance. Can be omitted for
update
because it is already specified in the URL.- password String
The password for the user.
- password
Policy UserPassword Validation Policy Response User level password validation policy.
- project String
The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for
update
because it is already specified on the URL.- sqlserver
User SqlDetails Server User Details Response - type String
The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
- dual
Password stringType Dual password status for the user.
- etag string
This field is deprecated and will be removed from a future version of the API.
This field is deprecated and will be removed from a future version of the API.
- host string
Optional. The host from which the user can connect. For
insert
operations, host defaults to an empty string. Forupdate
operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.- instance string
The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for
update
because it is already specified on the URL.- kind string
This is always
sql#user
.- name string
The name of the user in the Cloud SQL instance. Can be omitted for
update
because it is already specified in the URL.- password string
The password for the user.
- password
Policy UserPassword Validation Policy Response User level password validation policy.
- project string
The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for
update
because it is already specified on the URL.- sqlserver
User SqlDetails Server User Details Response - type string
The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
- dual_
password_ strtype Dual password status for the user.
- etag str
This field is deprecated and will be removed from a future version of the API.
This field is deprecated and will be removed from a future version of the API.
- host str
Optional. The host from which the user can connect. For
insert
operations, host defaults to an empty string. Forupdate
operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.- instance str
The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for
update
because it is already specified on the URL.- kind str
This is always
sql#user
.- name str
The name of the user in the Cloud SQL instance. Can be omitted for
update
because it is already specified in the URL.- password str
The password for the user.
- password_
policy UserPassword Validation Policy Response User level password validation policy.
- project str
The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for
update
because it is already specified on the URL.- sqlserver_
user_ Sqldetails Server User Details Response - type str
The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
- dual
Password StringType Dual password status for the user.
- etag String
This field is deprecated and will be removed from a future version of the API.
This field is deprecated and will be removed from a future version of the API.
- host String
Optional. The host from which the user can connect. For
insert
operations, host defaults to an empty string. Forupdate
operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.- instance String
The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for
update
because it is already specified on the URL.- kind String
This is always
sql#user
.- name String
The name of the user in the Cloud SQL instance. Can be omitted for
update
because it is already specified in the URL.- password String
The password for the user.
- password
Policy Property Map User level password validation policy.
- project String
The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for
update
because it is already specified on the URL.- sqlserver
User Property MapDetails - type String
The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type.
Supporting Types
PasswordStatusResponse
- Locked bool
If true, user does not have login privileges.
- Password
Expiration stringTime The expiration time of the current password.
- Locked bool
If true, user does not have login privileges.
- Password
Expiration stringTime The expiration time of the current password.
- locked Boolean
If true, user does not have login privileges.
- password
Expiration StringTime The expiration time of the current password.
- locked boolean
If true, user does not have login privileges.
- password
Expiration stringTime The expiration time of the current password.
- locked bool
If true, user does not have login privileges.
- password_
expiration_ strtime The expiration time of the current password.
- locked Boolean
If true, user does not have login privileges.
- password
Expiration StringTime The expiration time of the current password.
SqlServerUserDetailsResponse
- Disabled bool
If the user has been disabled
- Server
Roles List<string> The server roles for this user
- Disabled bool
If the user has been disabled
- Server
Roles []string The server roles for this user
- disabled Boolean
If the user has been disabled
- server
Roles List<String> The server roles for this user
- disabled boolean
If the user has been disabled
- server
Roles string[] The server roles for this user
- disabled bool
If the user has been disabled
- server_
roles Sequence[str] The server roles for this user
- disabled Boolean
If the user has been disabled
- server
Roles List<String> The server roles for this user
UserPasswordValidationPolicyResponse
- Allowed
Failed intAttempts Number of failed login attempts allowed before user get locked.
- Enable
Failed boolAttempts Check If true, failed login attempts check will be enabled.
- Enable
Password boolVerification If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
- Password
Expiration stringDuration Expiration duration after password is updated.
- Status
Pulumi.
Google Native. SQLAdmin. V1. Inputs. Password Status Response Read-only password status.
- Allowed
Failed intAttempts Number of failed login attempts allowed before user get locked.
- Enable
Failed boolAttempts Check If true, failed login attempts check will be enabled.
- Enable
Password boolVerification If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
- Password
Expiration stringDuration Expiration duration after password is updated.
- Status
Password
Status Response Read-only password status.
- allowed
Failed IntegerAttempts Number of failed login attempts allowed before user get locked.
- enable
Failed BooleanAttempts Check If true, failed login attempts check will be enabled.
- enable
Password BooleanVerification If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
- password
Expiration StringDuration Expiration duration after password is updated.
- status
Password
Status Response Read-only password status.
- allowed
Failed numberAttempts Number of failed login attempts allowed before user get locked.
- enable
Failed booleanAttempts Check If true, failed login attempts check will be enabled.
- enable
Password booleanVerification If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
- password
Expiration stringDuration Expiration duration after password is updated.
- status
Password
Status Response Read-only password status.
- allowed_
failed_ intattempts Number of failed login attempts allowed before user get locked.
- enable_
failed_ boolattempts_ check If true, failed login attempts check will be enabled.
- enable_
password_ boolverification If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
- password_
expiration_ strduration Expiration duration after password is updated.
- status
Password
Status Response Read-only password status.
- allowed
Failed NumberAttempts Number of failed login attempts allowed before user get locked.
- enable
Failed BooleanAttempts Check If true, failed login attempts check will be enabled.
- enable
Password BooleanVerification If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
- password
Expiration StringDuration Expiration duration after password is updated.
- status Property Map
Read-only password status.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.