1. Packages
  2. Google Cloud Native
  3. API Docs
  4. sqladmin
  5. sqladmin/v1beta4
  6. getUser

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.sqladmin/v1beta4.getUser

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

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>
Copy
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]
Copy
func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:sqladmin/v1beta4:getUser
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Instance This property is required. string
Name This property is required. string
Host string
Project string
Instance This property is required. string
Name This property is required. string
Host string
Project string
instance This property is required. String
name This property is required. String
host String
project String
instance This property is required. string
name This property is required. string
host string
project string
instance This property is required. str
name This property is required. str
host str
project str
instance This property is required. String
name This property is required. String
host String
project String

getUser Result

The following output properties are available:

DualPasswordType string
Dual password status for the user.
Etag string
This field is deprecated and will be removed from a future version of the API.

Deprecated: 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. For update 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.
PasswordPolicy Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.UserPasswordValidationPolicyResponse
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.
SqlserverUserDetails Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.SqlServerUserDetailsResponse
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.
DualPasswordType string
Dual password status for the user.
Etag string
This field is deprecated and will be removed from a future version of the API.

Deprecated: 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. For update 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.
PasswordPolicy UserPasswordValidationPolicyResponse
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.
SqlserverUserDetails SqlServerUserDetailsResponse
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.
dualPasswordType String
Dual password status for the user.
etag String
This field is deprecated and will be removed from a future version of the API.

Deprecated: 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. For update 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.
passwordPolicy UserPasswordValidationPolicyResponse
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.
sqlserverUserDetails SqlServerUserDetailsResponse
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.
dualPasswordType string
Dual password status for the user.
etag string
This field is deprecated and will be removed from a future version of the API.

Deprecated: 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. For update 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.
passwordPolicy UserPasswordValidationPolicyResponse
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.
sqlserverUserDetails SqlServerUserDetailsResponse
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_type str
Dual password status for the user.
etag str
This field is deprecated and will be removed from a future version of the API.

Deprecated: 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. For update 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 UserPasswordValidationPolicyResponse
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_details SqlServerUserDetailsResponse
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.
dualPasswordType String
Dual password status for the user.
etag String
This field is deprecated and will be removed from a future version of the API.

Deprecated: 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. For update 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.
passwordPolicy 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.
sqlserverUserDetails Property Map
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 This property is required. bool
If true, user does not have login privileges.
PasswordExpirationTime This property is required. string
The expiration time of the current password.
Locked This property is required. bool
If true, user does not have login privileges.
PasswordExpirationTime This property is required. string
The expiration time of the current password.
locked This property is required. Boolean
If true, user does not have login privileges.
passwordExpirationTime This property is required. String
The expiration time of the current password.
locked This property is required. boolean
If true, user does not have login privileges.
passwordExpirationTime This property is required. string
The expiration time of the current password.
locked This property is required. bool
If true, user does not have login privileges.
password_expiration_time This property is required. str
The expiration time of the current password.
locked This property is required. Boolean
If true, user does not have login privileges.
passwordExpirationTime This property is required. String
The expiration time of the current password.

SqlServerUserDetailsResponse

Disabled This property is required. bool
If the user has been disabled
ServerRoles This property is required. List<string>
The server roles for this user
Disabled This property is required. bool
If the user has been disabled
ServerRoles This property is required. []string
The server roles for this user
disabled This property is required. Boolean
If the user has been disabled
serverRoles This property is required. List<String>
The server roles for this user
disabled This property is required. boolean
If the user has been disabled
serverRoles This property is required. string[]
The server roles for this user
disabled This property is required. bool
If the user has been disabled
server_roles This property is required. Sequence[str]
The server roles for this user
disabled This property is required. Boolean
If the user has been disabled
serverRoles This property is required. List<String>
The server roles for this user

UserPasswordValidationPolicyResponse

AllowedFailedAttempts This property is required. int
Number of failed login attempts allowed before user get locked.
EnableFailedAttemptsCheck This property is required. bool
If true, failed login attempts check will be enabled.
EnablePasswordVerification This property is required. bool
If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
PasswordExpirationDuration This property is required. string
Expiration duration after password is updated.
Status This property is required. Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.PasswordStatusResponse
Read-only password status.
AllowedFailedAttempts This property is required. int
Number of failed login attempts allowed before user get locked.
EnableFailedAttemptsCheck This property is required. bool
If true, failed login attempts check will be enabled.
EnablePasswordVerification This property is required. bool
If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
PasswordExpirationDuration This property is required. string
Expiration duration after password is updated.
Status This property is required. PasswordStatusResponse
Read-only password status.
allowedFailedAttempts This property is required. Integer
Number of failed login attempts allowed before user get locked.
enableFailedAttemptsCheck This property is required. Boolean
If true, failed login attempts check will be enabled.
enablePasswordVerification This property is required. Boolean
If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
passwordExpirationDuration This property is required. String
Expiration duration after password is updated.
status This property is required. PasswordStatusResponse
Read-only password status.
allowedFailedAttempts This property is required. number
Number of failed login attempts allowed before user get locked.
enableFailedAttemptsCheck This property is required. boolean
If true, failed login attempts check will be enabled.
enablePasswordVerification This property is required. boolean
If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
passwordExpirationDuration This property is required. string
Expiration duration after password is updated.
status This property is required. PasswordStatusResponse
Read-only password status.
allowed_failed_attempts This property is required. int
Number of failed login attempts allowed before user get locked.
enable_failed_attempts_check This property is required. bool
If true, failed login attempts check will be enabled.
enable_password_verification This property is required. bool
If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
password_expiration_duration This property is required. str
Expiration duration after password is updated.
status This property is required. PasswordStatusResponse
Read-only password status.
allowedFailedAttempts This property is required. Number
Number of failed login attempts allowed before user get locked.
enableFailedAttemptsCheck This property is required. Boolean
If true, failed login attempts check will be enabled.
enablePasswordVerification This property is required. Boolean
If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
passwordExpirationDuration This property is required. String
Expiration duration after password is updated.
status This property is required. 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.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi